OperationOrBuilder (proto-google-cloud-compute-v1 1.21.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Operation, Operation.Builder
```
public interface OperationOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getClientOperationId()` [Output Only] The value of `requestId` if you provided it in the request.
`com.google.protobuf.ByteString`	`getClientOperationIdBytes()` [Output Only] The value of `requestId` if you provided it in the request.
`String`	`getCreationTimestamp()` [Deprecated] This field is deprecated.
`com.google.protobuf.ByteString`	`getCreationTimestampBytes()` [Deprecated] This field is deprecated.
`String`	`getDescription()` [Output Only] A textual description of the operation, which is set when the operation is created.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` [Output Only] A textual description of the operation, which is set when the operation is created.
`String`	`getEndTime()` [Output Only] The time that this operation was completed.
`com.google.protobuf.ByteString`	`getEndTimeBytes()` [Output Only] The time that this operation was completed.
`Error`	`getError()` [Output Only] If errors are generated during processing of the operation, this field will be populated.
`ErrorOrBuilder`	`getErrorOrBuilder()` [Output Only] If errors are generated during processing of the operation, this field will be populated.
`String`	`getHttpErrorMessage()` [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
`com.google.protobuf.ByteString`	`getHttpErrorMessageBytes()` [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
`int`	`getHttpErrorStatusCode()` [Output Only] If the operation fails, this field contains the HTTP error status code that was returned.
`long`	`getId()` [Output Only] The unique identifier for the operation.
`String`	`getInsertTime()` [Output Only] The time that this operation was requested.
`com.google.protobuf.ByteString`	`getInsertTimeBytes()` [Output Only] The time that this operation was requested.
`String`	`getKind()` [Output Only] Type of the resource.
`com.google.protobuf.ByteString`	`getKindBytes()` [Output Only] Type of the resource.
`String`	`getName()` [Output Only] Name of the operation.
`com.google.protobuf.ByteString`	`getNameBytes()` [Output Only] Name of the operation.
`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.
`com.google.protobuf.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.
`String`	`getOperationType()` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`com.google.protobuf.ByteString`	`getOperationTypeBytes()` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`int`	`getProgress()` [Output Only] An optional progress indicator that ranges from 0 to 100.
`String`	`getRegion()` [Output Only] The URL of the region where the operation resides.
`com.google.protobuf.ByteString`	`getRegionBytes()` [Output Only] The URL of the region where the operation resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`com.google.protobuf.ByteString`	`getSelfLinkBytes()` [Output Only] Server-defined URL for the resource.
`String`	`getStartTime()` [Output Only] The time that this operation was started by the server.
`com.google.protobuf.ByteString`	`getStartTimeBytes()` [Output Only] The time that this operation was started by the server.
`Operation.Status`	`getStatus()` [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
`String`	`getStatusMessage()` [Output Only] An optional textual description of the current status of the operation.
`com.google.protobuf.ByteString`	`getStatusMessageBytes()` [Output Only] An optional textual description of the current status of the operation.
`int`	`getStatusValue()` [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
`long`	`getTargetId()` [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`String`	`getTargetLink()` [Output Only] The URL of the resource that the operation modifies.
`com.google.protobuf.ByteString`	`getTargetLinkBytes()` [Output Only] The URL of the resource that the operation modifies.
`String`	`getUser()` [Output Only] User who requested the operation, for example: `user@example.com`.
`com.google.protobuf.ByteString`	`getUserBytes()` [Output Only] User who requested the operation, for example: `user@example.com`.
`Warnings`	`getWarnings(int index)` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`int`	`getWarningsCount()` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`List<Warnings>`	`getWarningsList()` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`WarningsOrBuilder`	`getWarningsOrBuilder(int index)` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`List<? extends WarningsOrBuilder>`	`getWarningsOrBuilderList()` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`String`	`getZone()` [Output Only] The URL of the zone where the operation resides.
`com.google.protobuf.ByteString`	`getZoneBytes()` [Output Only] The URL of the zone where the operation resides.
`boolean`	`hasClientOperationId()` [Output Only] The value of `requestId` if you provided it in the request.
`boolean`	`hasCreationTimestamp()` [Deprecated] This field is deprecated.
`boolean`	`hasDescription()` [Output Only] A textual description of the operation, which is set when the operation is created.
`boolean`	`hasEndTime()` [Output Only] The time that this operation was completed.
`boolean`	`hasError()` [Output Only] If errors are generated during processing of the operation, this field will be populated.
`boolean`	`hasHttpErrorMessage()` [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
`boolean`	`hasHttpErrorStatusCode()` [Output Only] If the operation fails, this field contains the HTTP error status code that was returned.
`boolean`	`hasId()` [Output Only] The unique identifier for the operation.
`boolean`	`hasInsertTime()` [Output Only] The time that this operation was requested.
`boolean`	`hasKind()` [Output Only] Type of the resource.
`boolean`	`hasName()` [Output Only] Name of the operation.
`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.
`boolean`	`hasOperationType()` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`boolean`	`hasProgress()` [Output Only] An optional progress indicator that ranges from 0 to 100.
`boolean`	`hasRegion()` [Output Only] The URL of the region where the operation resides.
`boolean`	`hasSelfLink()` [Output Only] Server-defined URL for the resource.
`boolean`	`hasStartTime()` [Output Only] The time that this operation was started by the server.
`boolean`	`hasStatus()` [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
`boolean`	`hasStatusMessage()` [Output Only] An optional textual description of the current status of the operation.
`boolean`	`hasTargetId()` [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`boolean`	`hasTargetLink()` [Output Only] The URL of the resource that the operation modifies.
`boolean`	`hasUser()` [Output Only] User who requested the operation, for example: `user@example.com`.
`boolean`	`hasZone()` [Output Only] The URL of the zone where the operation resides.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

hasClientOperationId

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:: Whether the clientOperationId field is set.

getClientOperationId

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:: The clientOperationId.

getClientOperationIdBytes

com.google.protobuf.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:: The bytes for clientOperationId.

hasCreationTimestamp
```
boolean hasCreationTimestamp()
```
```
 [Deprecated] This field is deprecated.
 
```
optional string creation_timestamp = 30525366;
Returns:

Whether the creationTimestamp field is set.

getCreationTimestamp
```
String getCreationTimestamp()
```
```
 [Deprecated] This field is deprecated.
 
```
optional string creation_timestamp = 30525366;
Returns:

The creationTimestamp.

getCreationTimestampBytes
```
com.google.protobuf.ByteString getCreationTimestampBytes()
```
```
 [Deprecated] This field is deprecated.
 
```
optional string creation_timestamp = 30525366;
Returns:

The bytes for creationTimestamp.

hasDescription

boolean hasDescription()

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

optional string description = 422937596;

Returns:: Whether the description field is set.

getDescription

String getDescription()

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

optional string description = 422937596;

Returns:: The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns:: The bytes for description.

hasEndTime

boolean hasEndTime()

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

optional string end_time = 114938801;

Returns:: Whether the endTime field is set.

getEndTime

String getEndTime()

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

optional string end_time = 114938801;

Returns:: The endTime.

getEndTimeBytes

com.google.protobuf.ByteString getEndTimeBytes()

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

optional string end_time = 114938801;

Returns:: The bytes for endTime.

hasError

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:: Whether the error field is set.

getError

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:: The error.

getErrorOrBuilder

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;

hasHttpErrorMessage
```
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:

Whether the httpErrorMessage field is set.

getHttpErrorMessage

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:: The httpErrorMessage.

getHttpErrorMessageBytes

com.google.protobuf.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:: The bytes for httpErrorMessage.

hasHttpErrorStatusCode

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:: Whether the httpErrorStatusCode field is set.

getHttpErrorStatusCode

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:: The httpErrorStatusCode.

hasId

boolean hasId()

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

optional uint64 id = 3355;

Returns:: Whether the id field is set.

getId

long getId()

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

optional uint64 id = 3355;

Returns:: The id.

hasInsertTime

boolean hasInsertTime()

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

optional string insert_time = 433722515;

Returns:: Whether the insertTime field is set.

getInsertTime

String getInsertTime()

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

optional string insert_time = 433722515;

Returns:: The insertTime.

getInsertTimeBytes

com.google.protobuf.ByteString getInsertTimeBytes()

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

optional string insert_time = 433722515;

Returns:: The bytes for insertTime.

hasKind

boolean hasKind()

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

optional string kind = 3292052;

Returns:: Whether the kind field is set.

getKind

String getKind()

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

optional string kind = 3292052;

Returns:: The kind.

getKindBytes

com.google.protobuf.ByteString getKindBytes()

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

optional string kind = 3292052;

Returns:: The bytes for kind.

hasName
```
boolean hasName()
```
```
 [Output Only] Name of the operation.
 
```
optional string name = 3373707 [(.google.cloud.operation_field) = NAME];
Returns:

Whether the name field is set.

getName
```
String getName()
```
```
 [Output Only] Name of the operation.
 
```
optional string name = 3373707 [(.google.cloud.operation_field) = NAME];
Returns:

The name.

getNameBytes
```
com.google.protobuf.ByteString getNameBytes()
```
```
 [Output Only] Name of the operation.
 
```
optional string name = 3373707 [(.google.cloud.operation_field) = NAME];
Returns:

The bytes for name.

hasOperationGroupId

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:: Whether the operationGroupId field is set.

getOperationGroupId

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:: The operationGroupId.

getOperationGroupIdBytes

com.google.protobuf.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:: The bytes for operationGroupId.

hasOperationType

boolean hasOperationType()

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

optional string operation_type = 177650450;

Returns:: Whether the operationType field is set.

getOperationType

String getOperationType()

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

optional string operation_type = 177650450;

Returns:: The operationType.

getOperationTypeBytes

com.google.protobuf.ByteString getOperationTypeBytes()

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

optional string operation_type = 177650450;

Returns:: The bytes for operationType.

hasProgress

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:: Whether the progress field is set.

getProgress

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:: The progress.

hasRegion

boolean hasRegion()

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

optional string region = 138946292;

Returns:: Whether the region field is set.

getRegion

String getRegion()

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

optional string region = 138946292;

Returns:: The region.

getRegionBytes

com.google.protobuf.ByteString getRegionBytes()

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

optional string region = 138946292;

Returns:: The bytes for region.

hasSelfLink
```
boolean hasSelfLink()
```
```
 [Output Only] Server-defined URL for the resource.
 
```
optional string self_link = 456214797;
Returns:

Whether the selfLink field is set.

getSelfLink

String getSelfLink()

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

optional string self_link = 456214797;

Returns:: The selfLink.

getSelfLinkBytes

com.google.protobuf.ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns:: The bytes for selfLink.

hasStartTime

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:: Whether the startTime field is set.

getStartTime

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:: The startTime.

getStartTimeBytes

com.google.protobuf.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:: The bytes for startTime.

hasStatus
```
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:

Whether the status field is set.

getStatusValue
```
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:

The enum numeric value on the wire for status.

getStatus

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:: The status.

hasStatusMessage

boolean hasStatusMessage()

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

optional string status_message = 297428154;

Returns:: Whether the statusMessage field is set.

getStatusMessage

String getStatusMessage()

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

optional string status_message = 297428154;

Returns:: The statusMessage.

getStatusMessageBytes

com.google.protobuf.ByteString getStatusMessageBytes()

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

optional string status_message = 297428154;

Returns:: The bytes for statusMessage.

hasTargetId

boolean hasTargetId()

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

optional uint64 target_id = 258165385;

Returns:: Whether the targetId field is set.

getTargetId

long getTargetId()

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

optional uint64 target_id = 258165385;

Returns:: The targetId.

hasTargetLink

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:: Whether the targetLink field is set.

getTargetLink

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:: The targetLink.

getTargetLinkBytes

com.google.protobuf.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:: The bytes for targetLink.

hasUser

boolean hasUser()

 [Output Only] User who requested the operation, for example: `user@example.com`.

optional string user = 3599307;

Returns:: Whether the user field is set.

getUser

String getUser()

 [Output Only] User who requested the operation, for example: `user@example.com`.

optional string user = 3599307;

Returns:: The user.

getUserBytes

com.google.protobuf.ByteString getUserBytes()

 [Output Only] User who requested the operation, for example: `user@example.com`.

optional string user = 3599307;

Returns:: The bytes for user.