public static final class FailoverInstanceRequest.Builder extends GeneratedMessageV3.Builder<FailoverInstanceRequest.Builder> implements FailoverInstanceRequestOrBuilder
Message for triggering failover on an Instance
Protobuf type google.cloud.alloydb.v1.FailoverInstanceRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public FailoverInstanceRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public FailoverInstanceRequest build()
buildPartial()
public FailoverInstanceRequest buildPartial()
clear()
public FailoverInstanceRequest.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public FailoverInstanceRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearName()
public FailoverInstanceRequest.Builder clearName()
Required. The name of the resource. For the required format, see the
comment on the Instance.name field.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
clearOneof(Descriptors.OneofDescriptor oneof)
public FailoverInstanceRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearRequestId()
public FailoverInstanceRequest.Builder clearRequestId()
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];
clearValidateOnly()
public FailoverInstanceRequest.Builder clearValidateOnly()
Optional. If set, performs request validation (e.g. permission checks and
any other type of validation), but do not actually execute the failover.
bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];
clone()
public FailoverInstanceRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public FailoverInstanceRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getName()
Required. The name of the resource. For the required format, see the
comment on the Instance.name field.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The name of the resource. For the required format, see the
comment on the Instance.name field.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getRequestId()
public String getRequestId()
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The requestId.
|
getRequestIdBytes()
public ByteString getRequestIdBytes()
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for requestId.
|
getValidateOnly()
public boolean getValidateOnly()
Optional. If set, performs request validation (e.g. permission checks and
any other type of validation), but do not actually execute the failover.
bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
The validateOnly.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(FailoverInstanceRequest other)
public FailoverInstanceRequest.Builder mergeFrom(FailoverInstanceRequest other)
public FailoverInstanceRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public FailoverInstanceRequest.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final FailoverInstanceRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public FailoverInstanceRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setName(String value)
public FailoverInstanceRequest.Builder setName(String value)
Required. The name of the resource. For the required format, see the
comment on the Instance.name field.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
String
The name to set.
|
setNameBytes(ByteString value)
public FailoverInstanceRequest.Builder setNameBytes(ByteString value)
Required. The name of the resource. For the required format, see the
comment on the Instance.name field.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for name to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public FailoverInstanceRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setRequestId(String value)
public FailoverInstanceRequest.Builder setRequestId(String value)
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
value |
String
The requestId to set.
|
setRequestIdBytes(ByteString value)
public FailoverInstanceRequest.Builder setRequestIdBytes(ByteString value)
Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes after the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same request
ID, the server can check if original operation with the same request ID
was received, and if so, will ignore the second request. This prevents
clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID is
not supported (00000000-0000-0000-0000-000000000000).
string request_id = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for requestId to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final FailoverInstanceRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
setValidateOnly(boolean value)
public FailoverInstanceRequest.Builder setValidateOnly(boolean value)
Optional. If set, performs request validation (e.g. permission checks and
any other type of validation), but do not actually execute the failover.
bool validate_only = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
value |
boolean
The validateOnly to set.
|
