Interface OperationOrBuilder (1.47.0)

Version 1.47.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface OperationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getClientOperationId()

public abstract String getClientOperationId()

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

optional string client_operation_id = 297240295;

Returns
Type	Description
String	The clientOperationId.

getClientOperationIdBytes()

public abstract ByteString getClientOperationIdBytes()

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

optional string client_operation_id = 297240295;

Returns
Type	Description
ByteString	The bytes for clientOperationId.

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Deprecated] This field is deprecated.

optional string creation_timestamp = 30525366;

Returns
Type	Description
String	The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Deprecated] This field is deprecated.

optional string creation_timestamp = 30525366;

Returns
Type	Description
ByteString	The bytes for creationTimestamp.

getDescription()

public abstract String getDescription()

[Output Only] A textual description of the operation, which is set when the operation is created.

optional string description = 422937596;

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

[Output Only] A textual description of the operation, which is set when the operation is created.

optional string description = 422937596;

Returns
Type	Description
ByteString	The bytes for description.

getEndTime()

public abstract String getEndTime()

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

optional string end_time = 114938801;

Returns
Type	Description
String	The endTime.

getEndTimeBytes()

public abstract ByteString getEndTimeBytes()

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

optional string end_time = 114938801;

Returns
Type	Description
ByteString	The bytes for endTime.

getError()

public abstract Error getError()

[Output Only] If errors are generated during processing of the operation, this field will be populated.

optional .google.cloud.compute.v1.Error error = 96784904;

Returns
Type	Description
Error	The error.

getErrorOrBuilder()

public abstract ErrorOrBuilder getErrorOrBuilder()

[Output Only] If errors are generated during processing of the operation, this field will be populated.

optional .google.cloud.compute.v1.Error error = 96784904;

Returns
Type	Description
ErrorOrBuilder

getHttpErrorMessage()

public abstract String getHttpErrorMessage()

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

optional string http_error_message = 202521945 [(.google.cloud.operation_field) = ERROR_MESSAGE];

Returns
Type	Description
String	The httpErrorMessage.

getHttpErrorMessageBytes()

public abstract ByteString getHttpErrorMessageBytes()

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

optional string http_error_message = 202521945 [(.google.cloud.operation_field) = ERROR_MESSAGE];

Returns
Type	Description
ByteString	The bytes for httpErrorMessage.

getHttpErrorStatusCode()

public abstract int getHttpErrorStatusCode()

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

optional int32 http_error_status_code = 312345196 [(.google.cloud.operation_field) = ERROR_CODE];

Returns
Type	Description
int	The httpErrorStatusCode.

getId()

public abstract long getId()

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type	Description
long	The id.

getInsertTime()

public abstract String getInsertTime()

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

optional string insert_time = 433722515;

Returns
Type	Description
String	The insertTime.

getInsertTimeBytes()

public abstract ByteString getInsertTimeBytes()

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

optional string insert_time = 433722515;

Returns
Type	Description
ByteString	The bytes for insertTime.

getInstancesBulkInsertOperationMetadata()

public abstract InstancesBulkInsertOperationMetadata getInstancesBulkInsertOperationMetadata()

optional .google.cloud.compute.v1.InstancesBulkInsertOperationMetadata instances_bulk_insert_operation_metadata = 89146177;

Returns
Type	Description
InstancesBulkInsertOperationMetadata	The instancesBulkInsertOperationMetadata.

getInstancesBulkInsertOperationMetadataOrBuilder()

public abstract InstancesBulkInsertOperationMetadataOrBuilder getInstancesBulkInsertOperationMetadataOrBuilder()

optional .google.cloud.compute.v1.InstancesBulkInsertOperationMetadata instances_bulk_insert_operation_metadata = 89146177;

Returns
Type	Description
InstancesBulkInsertOperationMetadataOrBuilder

getKind()

public abstract String getKind()

[Output Only] Type of the resource. Always compute#operation for Operation resources.

optional string kind = 3292052;

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#operation for Operation resources.

optional string kind = 3292052;

Returns
Type	Description
ByteString	The bytes for kind.

getName()

public abstract String getName()

[Output Only] Name of the operation.

optional string name = 3373707 [(.google.cloud.operation_field) = NAME];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

[Output Only] Name of the operation.

optional string name = 3373707 [(.google.cloud.operation_field) = NAME];

Returns
Type	Description
ByteString	The bytes for name.

getOperationGroupId()

public abstract String getOperationGroupId()

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

optional string operation_group_id = 40171187;

Returns
Type	Description
String	The operationGroupId.

getOperationGroupIdBytes()

public abstract ByteString getOperationGroupIdBytes()

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

optional string operation_group_id = 40171187;

Returns
Type	Description
ByteString	The bytes for operationGroupId.

getOperationType()

public abstract String getOperationType()

[Output Only] The type of operation, such as insert, update, or delete, and so on.

optional string operation_type = 177650450;

Returns
Type	Description
String	The operationType.

getOperationTypeBytes()

public abstract ByteString getOperationTypeBytes()

[Output Only] The type of operation, such as insert, update, or delete, and so on.

optional string operation_type = 177650450;

Returns
Type	Description
ByteString	The bytes for operationType.

getProgress()

public abstract int getProgress()

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

optional int32 progress = 72663597;

Returns
Type	Description
int	The progress.

getRegion()

public abstract String getRegion()

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

optional string region = 138946292;

Returns
Type	Description
String	The region.

getRegionBytes()

public abstract ByteString getRegionBytes()

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

optional string region = 138946292;

Returns
Type	Description
ByteString	The bytes for region.

getSelfLink()

public abstract String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type	Description
String	The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type	Description
ByteString	The bytes for selfLink.

getSetCommonInstanceMetadataOperationMetadata()

public abstract SetCommonInstanceMetadataOperationMetadata getSetCommonInstanceMetadataOperationMetadata()

[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.

optional .google.cloud.compute.v1.SetCommonInstanceMetadataOperationMetadata set_common_instance_metadata_operation_metadata = 490378980;

Returns
Type	Description
SetCommonInstanceMetadataOperationMetadata	The setCommonInstanceMetadataOperationMetadata.

getSetCommonInstanceMetadataOperationMetadataOrBuilder()

public abstract SetCommonInstanceMetadataOperationMetadataOrBuilder getSetCommonInstanceMetadataOperationMetadataOrBuilder()

[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.

optional .google.cloud.compute.v1.SetCommonInstanceMetadataOperationMetadata set_common_instance_metadata_operation_metadata = 490378980;

Returns
Type	Description
SetCommonInstanceMetadataOperationMetadataOrBuilder

getStartTime()

public abstract String getStartTime()

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

optional string start_time = 37467274;

Returns
Type	Description
String	The startTime.

getStartTimeBytes()

public abstract ByteString getStartTimeBytes()

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

optional string start_time = 37467274;

Returns
Type	Description
ByteString	The bytes for startTime.

getStatus()

public abstract Operation.Status getStatus()

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

optional .google.cloud.compute.v1.Operation.Status status = 181260274 [(.google.cloud.operation_field) = STATUS];

Returns
Type	Description
Operation.Status	The status.

getStatusMessage()

public abstract String getStatusMessage()

[Output Only] An optional textual description of the current status of the operation.

optional string status_message = 297428154;

Returns
Type	Description
String	The statusMessage.

getStatusMessageBytes()

public abstract ByteString getStatusMessageBytes()

[Output Only] An optional textual description of the current status of the operation.

optional string status_message = 297428154;

Returns
Type	Description
ByteString	The bytes for statusMessage.

getStatusValue()

public abstract int getStatusValue()

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

optional .google.cloud.compute.v1.Operation.Status status = 181260274 [(.google.cloud.operation_field) = STATUS];

Returns
Type	Description
int	The enum numeric value on the wire for status.

getTargetId()

public abstract long getTargetId()

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

optional uint64 target_id = 258165385;

Returns
Type	Description
long	The targetId.

getTargetLink()

public abstract String getTargetLink()

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

optional string target_link = 62671336;

Returns
Type	Description
String	The targetLink.

getTargetLinkBytes()

public abstract ByteString getTargetLinkBytes()

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

optional string target_link = 62671336;

Returns
Type	Description
ByteString	The bytes for targetLink.

getUser()

public abstract String getUser()

[Output Only] User who requested the operation, for example: [e-mail] or alice_smith_identifier (global/workforcePools/example-com-us-employees).

optional string user = 3599307;

Returns
Type	Description
String	The user.

getUserBytes()

public abstract ByteString getUserBytes()

[Output Only] User who requested the operation, for example: [e-mail] or alice_smith_identifier (global/workforcePools/example-com-us-employees).

optional string user = 3599307;

Returns
Type	Description
ByteString	The bytes for user.

getWarnings(int index)

public abstract Warnings getWarnings(int index)

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Parameter
Name	Description
index	int

Returns
Type	Description
Warnings

getWarningsCount()

public abstract int getWarningsCount()

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
Type	Description
int

getWarningsList()

public abstract List<Warnings> getWarningsList()

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
Type	Description
List<Warnings>

getWarningsOrBuilder(int index)

public abstract WarningsOrBuilder getWarningsOrBuilder(int index)

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Parameter
Name	Description
index	int

Returns
Type	Description
WarningsOrBuilder

getWarningsOrBuilderList()

public abstract List<? extends WarningsOrBuilder> getWarningsOrBuilderList()

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
Type	Description
List<? extends com.google.cloud.compute.v1.WarningsOrBuilder>

getZone()

public abstract String getZone()

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

optional string zone = 3744684;

Returns
Type	Description
String	The zone.

getZoneBytes()

public abstract ByteString getZoneBytes()

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

optional string zone = 3744684;

Returns
Type	Description
ByteString	The bytes for zone.

hasClientOperationId()

public abstract boolean hasClientOperationId()

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

optional string client_operation_id = 297240295;

Returns
Type	Description
boolean	Whether the clientOperationId field is set.

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

[Deprecated] This field is deprecated.

optional string creation_timestamp = 30525366;

Returns
Type	Description
boolean	Whether the creationTimestamp field is set.

hasDescription()

public abstract boolean hasDescription()

[Output Only] A textual description of the operation, which is set when the operation is created.

optional string description = 422937596;

Returns
Type	Description
boolean	Whether the description field is set.

hasEndTime()

public abstract boolean hasEndTime()

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

optional string end_time = 114938801;

Returns
Type	Description
boolean	Whether the endTime field is set.

hasError()

public abstract boolean hasError()

[Output Only] If errors are generated during processing of the operation, this field will be populated.

optional .google.cloud.compute.v1.Error error = 96784904;

Returns
Type	Description
boolean	Whether the error field is set.

hasHttpErrorMessage()

public abstract boolean hasHttpErrorMessage()

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

optional string http_error_message = 202521945 [(.google.cloud.operation_field) = ERROR_MESSAGE];

Returns
Type	Description
boolean	Whether the httpErrorMessage field is set.

hasHttpErrorStatusCode()

public abstract boolean hasHttpErrorStatusCode()

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

optional int32 http_error_status_code = 312345196 [(.google.cloud.operation_field) = ERROR_CODE];

Returns
Type	Description
boolean	Whether the httpErrorStatusCode field is set.

hasId()

public abstract boolean hasId()

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type	Description
boolean	Whether the id field is set.

hasInsertTime()

public abstract boolean hasInsertTime()

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

optional string insert_time = 433722515;

Returns
Type	Description
boolean	Whether the insertTime field is set.

hasInstancesBulkInsertOperationMetadata()

public abstract boolean hasInstancesBulkInsertOperationMetadata()

optional .google.cloud.compute.v1.InstancesBulkInsertOperationMetadata instances_bulk_insert_operation_metadata = 89146177;

Returns
Type	Description
boolean	Whether the instancesBulkInsertOperationMetadata field is set.

hasKind()

public abstract boolean hasKind()

[Output Only] Type of the resource. Always compute#operation for Operation resources.

optional string kind = 3292052;

Returns
Type	Description
boolean	Whether the kind field is set.

hasName()

public abstract boolean hasName()

[Output Only] Name of the operation.

optional string name = 3373707 [(.google.cloud.operation_field) = NAME];

Returns
Type	Description
boolean	Whether the name field is set.

hasOperationGroupId()

public abstract boolean hasOperationGroupId()

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

optional string operation_group_id = 40171187;

Returns
Type	Description
boolean	Whether the operationGroupId field is set.

hasOperationType()

public abstract boolean hasOperationType()

[Output Only] The type of operation, such as insert, update, or delete, and so on.

optional string operation_type = 177650450;

Returns
Type	Description
boolean	Whether the operationType field is set.

hasProgress()

public abstract boolean hasProgress()

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

optional int32 progress = 72663597;

Returns
Type	Description
boolean	Whether the progress field is set.

hasRegion()

public abstract boolean hasRegion()

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

optional string region = 138946292;

Returns
Type	Description
boolean	Whether the region field is set.

hasSelfLink()

public abstract boolean hasSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type	Description
boolean	Whether the selfLink field is set.

hasSetCommonInstanceMetadataOperationMetadata()

public abstract boolean hasSetCommonInstanceMetadataOperationMetadata()

[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.

optional .google.cloud.compute.v1.SetCommonInstanceMetadataOperationMetadata set_common_instance_metadata_operation_metadata = 490378980;

Returns
Type	Description
boolean	Whether the setCommonInstanceMetadataOperationMetadata field is set.

hasStartTime()

public abstract boolean hasStartTime()

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

optional string start_time = 37467274;

Returns
Type	Description
boolean	Whether the startTime field is set.

hasStatus()

public abstract boolean hasStatus()

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

optional .google.cloud.compute.v1.Operation.Status status = 181260274 [(.google.cloud.operation_field) = STATUS];

Returns
Type	Description
boolean	Whether the status field is set.

hasStatusMessage()

public abstract boolean hasStatusMessage()

[Output Only] An optional textual description of the current status of the operation.

optional string status_message = 297428154;

Returns
Type	Description
boolean	Whether the statusMessage field is set.

hasTargetId()

public abstract boolean hasTargetId()

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

optional uint64 target_id = 258165385;

Returns
Type	Description
boolean	Whether the targetId field is set.

hasTargetLink()

public abstract boolean hasTargetLink()

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

optional string target_link = 62671336;

Returns
Type	Description
boolean	Whether the targetLink field is set.

hasUser()

public abstract boolean hasUser()

[Output Only] User who requested the operation, for example: [e-mail] or alice_smith_identifier (global/workforcePools/example-com-us-employees).

optional string user = 3599307;

Returns
Type	Description
boolean	Whether the user field is set.

hasZone()

public abstract boolean hasZone()

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

optional string zone = 3744684;

Returns
Type	Description
boolean	Whether the zone field is set.