Class Operation (0.1.0)

public final class Operation extends GeneratedMessage implements OperationOrBuilder

An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.

Protobuf type google.cloud.sql.v1beta4.Operation

Implements

OperationOrBuilder

Static Fields

ACQUIRE_SSRS_LEASE_CONTEXT_FIELD_NUMBER

public static final int ACQUIRE_SSRS_LEASE_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

API_WARNING_FIELD_NUMBER

public static final int API_WARNING_FIELD_NUMBER
Field Value
Type Description
int

BACKUP_CONTEXT_FIELD_NUMBER

public static final int BACKUP_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

EXPORT_CONTEXT_FIELD_NUMBER

public static final int EXPORT_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

IMPORT_CONTEXT_FIELD_NUMBER

public static final int IMPORT_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

INSERT_TIME_FIELD_NUMBER

public static final int INSERT_TIME_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_TYPE_FIELD_NUMBER

public static final int OPERATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PRE_CHECK_MAJOR_VERSION_UPGRADE_CONTEXT_FIELD_NUMBER

public static final int PRE_CHECK_MAJOR_VERSION_UPGRADE_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

SUB_OPERATION_TYPE_FIELD_NUMBER

public static final int SUB_OPERATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

TARGET_ID_FIELD_NUMBER

public static final int TARGET_ID_FIELD_NUMBER
Field Value
Type Description
int
public static final int TARGET_LINK_FIELD_NUMBER
Field Value
Type Description
int

TARGET_PROJECT_FIELD_NUMBER

public static final int TARGET_PROJECT_FIELD_NUMBER
Field Value
Type Description
int

USER_FIELD_NUMBER

public static final int USER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Operation getDefaultInstance()
Returns
Type Description
Operation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Operation.Builder newBuilder()
Returns
Type Description
Operation.Builder

newBuilder(Operation prototype)

public static Operation.Builder newBuilder(Operation prototype)
Parameter
Name Description
prototype Operation
Returns
Type Description
Operation.Builder

parseDelimitedFrom(InputStream input)

public static Operation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Operation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Operation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Operation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Operation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Operation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Operation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Operation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Operation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Operation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Operation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Operation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Operation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Operation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Operation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Operation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Operation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Operation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Operation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Operation> parser()
Returns
Type Description
Parser<Operation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAcquireSsrsLeaseContext()

public AcquireSsrsLeaseContext getAcquireSsrsLeaseContext()

The context for acquire SSRS lease operation, if applicable.

.google.cloud.sql.v1beta4.AcquireSsrsLeaseContext acquire_ssrs_lease_context = 20;

Returns
Type Description
AcquireSsrsLeaseContext

The acquireSsrsLeaseContext.

getAcquireSsrsLeaseContextOrBuilder()

public AcquireSsrsLeaseContextOrBuilder getAcquireSsrsLeaseContextOrBuilder()

The context for acquire SSRS lease operation, if applicable.

.google.cloud.sql.v1beta4.AcquireSsrsLeaseContext acquire_ssrs_lease_context = 20;

Returns
Type Description
AcquireSsrsLeaseContextOrBuilder

getApiWarning()

public ApiWarning getApiWarning()

An Admin API warning message.

.google.cloud.sql.v1beta4.ApiWarning api_warning = 19;

Returns
Type Description
ApiWarning

The apiWarning.

getApiWarningOrBuilder()

public ApiWarningOrBuilder getApiWarningOrBuilder()

An Admin API warning message.

.google.cloud.sql.v1beta4.ApiWarning api_warning = 19;

Returns
Type Description
ApiWarningOrBuilder

getBackupContext()

public BackupContext getBackupContext()

The context for backup operation, if applicable.

.google.cloud.sql.v1beta4.BackupContext backup_context = 17;

Returns
Type Description
BackupContext

The backupContext.

getBackupContextOrBuilder()

public BackupContextOrBuilder getBackupContextOrBuilder()

The context for backup operation, if applicable.

.google.cloud.sql.v1beta4.BackupContext backup_context = 17;

Returns
Type Description
BackupContextOrBuilder

getDefaultInstanceForType()

public Operation getDefaultInstanceForType()
Returns
Type Description
Operation

getEndTime()

public Timestamp getEndTime()

The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp end_time = 7;

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp end_time = 7;

Returns
Type Description
TimestampOrBuilder

getError()

public OperationErrors getError()

If errors occurred during processing of this operation, this field will be populated.

.google.cloud.sql.v1beta4.OperationErrors error = 8;

Returns
Type Description
OperationErrors

The error.

getErrorOrBuilder()

public OperationErrorsOrBuilder getErrorOrBuilder()

If errors occurred during processing of this operation, this field will be populated.

.google.cloud.sql.v1beta4.OperationErrors error = 8;

Returns
Type Description
OperationErrorsOrBuilder

getExportContext()

public ExportContext getExportContext()

The context for export operation, if applicable.

.google.cloud.sql.v1beta4.ExportContext export_context = 11;

Returns
Type Description
ExportContext

The exportContext.

getExportContextOrBuilder()

public ExportContextOrBuilder getExportContextOrBuilder()

The context for export operation, if applicable.

.google.cloud.sql.v1beta4.ExportContext export_context = 11;

Returns
Type Description
ExportContextOrBuilder

getImportContext()

public ImportContext getImportContext()

The context for import operation, if applicable.

.google.cloud.sql.v1beta4.ImportContext import_context = 10;

Returns
Type Description
ImportContext

The importContext.

getImportContextOrBuilder()

public ImportContextOrBuilder getImportContextOrBuilder()

The context for import operation, if applicable.

.google.cloud.sql.v1beta4.ImportContext import_context = 10;

Returns
Type Description
ImportContextOrBuilder

getInsertTime()

public Timestamp getInsertTime()

The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp insert_time = 5;

Returns
Type Description
Timestamp

The insertTime.

getInsertTimeOrBuilder()

public TimestampOrBuilder getInsertTimeOrBuilder()

The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp insert_time = 5;

Returns
Type Description
TimestampOrBuilder

getKind()

public String getKind()

This is always sql#operation.

string kind = 1;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

This is always sql#operation.

string kind = 1;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public String getName()

An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

string name = 12;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.

string name = 12;

Returns
Type Description
ByteString

The bytes for name.

getOperationType()

public Operation.SqlOperationType getOperationType()

The type of the operation. Valid values are:

  • CREATE
  • DELETE
  • UPDATE
  • RESTART
  • IMPORT
  • EXPORT
  • BACKUP_VOLUME
  • RESTORE_VOLUME
  • CREATE_USER
  • DELETE_USER
  • CREATE_DATABASE
  • DELETE_DATABASE

.google.cloud.sql.v1beta4.Operation.SqlOperationType operation_type = 9;

Returns
Type Description
Operation.SqlOperationType

The operationType.

getOperationTypeValue()

public int getOperationTypeValue()

The type of the operation. Valid values are:

  • CREATE
  • DELETE
  • UPDATE
  • RESTART
  • IMPORT
  • EXPORT
  • BACKUP_VOLUME
  • RESTORE_VOLUME
  • CREATE_USER
  • DELETE_USER
  • CREATE_DATABASE
  • DELETE_DATABASE

.google.cloud.sql.v1beta4.Operation.SqlOperationType operation_type = 9;

Returns
Type Description
int

The enum numeric value on the wire for operationType.

getParserForType()

public Parser<Operation> getParserForType()
Returns
Type Description
Parser<Operation>
Overrides

getPreCheckMajorVersionUpgradeContext()

public PreCheckMajorVersionUpgradeContext getPreCheckMajorVersionUpgradeContext()

The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).

.google.cloud.sql.v1beta4.PreCheckMajorVersionUpgradeContext pre_check_major_version_upgrade_context = 50;

Returns
Type Description
PreCheckMajorVersionUpgradeContext

The preCheckMajorVersionUpgradeContext.

getPreCheckMajorVersionUpgradeContextOrBuilder()

public PreCheckMajorVersionUpgradeContextOrBuilder getPreCheckMajorVersionUpgradeContextOrBuilder()

The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).

.google.cloud.sql.v1beta4.PreCheckMajorVersionUpgradeContext pre_check_major_version_upgrade_context = 50;

Returns
Type Description
PreCheckMajorVersionUpgradeContextOrBuilder
public String getSelfLink()

The URI of this resource.

string self_link = 14;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

The URI of this resource.

string self_link = 14;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp start_time = 6;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp start_time = 6;

Returns
Type Description
TimestampOrBuilder

getStatus()

public Operation.SqlOperationStatus getStatus()

The status of an operation.

.google.cloud.sql.v1beta4.Operation.SqlOperationStatus status = 3;

Returns
Type Description
Operation.SqlOperationStatus

The status.

getStatusValue()

public int getStatusValue()

The status of an operation.

.google.cloud.sql.v1beta4.Operation.SqlOperationStatus status = 3;

Returns
Type Description
int

The enum numeric value on the wire for status.

getSubOperationType()

public SqlSubOperationType getSubOperationType()

Optional. The sub operation based on the operation type.

.google.cloud.sql.v1beta4.SqlSubOperationType sub_operation_type = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SqlSubOperationType

The subOperationType.

getSubOperationTypeOrBuilder()

public SqlSubOperationTypeOrBuilder getSubOperationTypeOrBuilder()

Optional. The sub operation based on the operation type.

.google.cloud.sql.v1beta4.SqlSubOperationType sub_operation_type = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SqlSubOperationTypeOrBuilder

getTargetId()

public String getTargetId()

Name of the resource on which this operation runs.

string target_id = 13;

Returns
Type Description
String

The targetId.

getTargetIdBytes()

public ByteString getTargetIdBytes()

Name of the resource on which this operation runs.

string target_id = 13;

Returns
Type Description
ByteString

The bytes for targetId.

public String getTargetLink()

string target_link = 2;

Returns
Type Description
String

The targetLink.

getTargetLinkBytes()

public ByteString getTargetLinkBytes()

string target_link = 2;

Returns
Type Description
ByteString

The bytes for targetLink.

getTargetProject()

public String getTargetProject()

The project ID of the target instance related to this operation.

string target_project = 15;

Returns
Type Description
String

The targetProject.

getTargetProjectBytes()

public ByteString getTargetProjectBytes()

The project ID of the target instance related to this operation.

string target_project = 15;

Returns
Type Description
ByteString

The bytes for targetProject.

getUser()

public String getUser()

The email address of the user who initiated this operation.

string user = 4;

Returns
Type Description
String

The user.

getUserBytes()

public ByteString getUserBytes()

The email address of the user who initiated this operation.

string user = 4;

Returns
Type Description
ByteString

The bytes for user.

hasAcquireSsrsLeaseContext()

public boolean hasAcquireSsrsLeaseContext()

The context for acquire SSRS lease operation, if applicable.

.google.cloud.sql.v1beta4.AcquireSsrsLeaseContext acquire_ssrs_lease_context = 20;

Returns
Type Description
boolean

Whether the acquireSsrsLeaseContext field is set.

hasApiWarning()

public boolean hasApiWarning()

An Admin API warning message.

.google.cloud.sql.v1beta4.ApiWarning api_warning = 19;

Returns
Type Description
boolean

Whether the apiWarning field is set.

hasBackupContext()

public boolean hasBackupContext()

The context for backup operation, if applicable.

.google.cloud.sql.v1beta4.BackupContext backup_context = 17;

Returns
Type Description
boolean

Whether the backupContext field is set.

hasEndTime()

public boolean hasEndTime()

The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp end_time = 7;

Returns
Type Description
boolean

Whether the endTime field is set.

hasError()

public boolean hasError()

If errors occurred during processing of this operation, this field will be populated.

.google.cloud.sql.v1beta4.OperationErrors error = 8;

Returns
Type Description
boolean

Whether the error field is set.

hasExportContext()

public boolean hasExportContext()

The context for export operation, if applicable.

.google.cloud.sql.v1beta4.ExportContext export_context = 11;

Returns
Type Description
boolean

Whether the exportContext field is set.

hasImportContext()

public boolean hasImportContext()

The context for import operation, if applicable.

.google.cloud.sql.v1beta4.ImportContext import_context = 10;

Returns
Type Description
boolean

Whether the importContext field is set.

hasInsertTime()

public boolean hasInsertTime()

The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp insert_time = 5;

Returns
Type Description
boolean

Whether the insertTime field is set.

hasPreCheckMajorVersionUpgradeContext()

public boolean hasPreCheckMajorVersionUpgradeContext()

The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).

.google.cloud.sql.v1beta4.PreCheckMajorVersionUpgradeContext pre_check_major_version_upgrade_context = 50;

Returns
Type Description
boolean

Whether the preCheckMajorVersionUpgradeContext field is set.

hasStartTime()

public boolean hasStartTime()

The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

.google.protobuf.Timestamp start_time = 6;

Returns
Type Description
boolean

Whether the startTime field is set.

hasSubOperationType()

public boolean hasSubOperationType()

Optional. The sub operation based on the operation type.

.google.cloud.sql.v1beta4.SqlSubOperationType sub_operation_type = 48 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the subOperationType field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Operation.Builder newBuilderForType()
Returns
Type Description
Operation.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Operation.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Operation.Builder
Overrides

toBuilder()

public Operation.Builder toBuilder()
Returns
Type Description
Operation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException