public final class FailoverInstanceRequest extends GeneratedMessageV3 implements FailoverInstanceRequestOrBuilder
Message for triggering failover on an Instance
Protobuf type google.cloud.alloydb.v1.FailoverInstanceRequest
Static Fields
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUEST_ID_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VALIDATE_ONLY_FIELD_NUMBER
public static final int VALIDATE_ONLY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static FailoverInstanceRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static FailoverInstanceRequest.Builder newBuilder()
newBuilder(FailoverInstanceRequest prototype)
public static FailoverInstanceRequest.Builder newBuilder(FailoverInstanceRequest prototype)
public static FailoverInstanceRequest parseDelimitedFrom(InputStream input)
public static FailoverInstanceRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static FailoverInstanceRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FailoverInstanceRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static FailoverInstanceRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FailoverInstanceRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FailoverInstanceRequest parseFrom(CodedInputStream input)
public static FailoverInstanceRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FailoverInstanceRequest parseFrom(InputStream input)
public static FailoverInstanceRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static FailoverInstanceRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FailoverInstanceRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<FailoverInstanceRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public FailoverInstanceRequest getDefaultInstanceForType()
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.
|
getParserForType()
public Parser<FailoverInstanceRequest> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public FailoverInstanceRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FailoverInstanceRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public FailoverInstanceRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
