Class Operation.Builder (1.34.0)

public static final class Operation.Builder extends GeneratedMessageV3.Builder<Operation.Builder> implements OperationOrBuilder

Represents an Operation resource. Google Compute Engine has three Operation resources: * Global * Regional * Zonal You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources.

Protobuf type google.cloud.compute.v1.Operation

Implements

OperationOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllWarnings(Iterable<? extends Warnings> values)

public Operation.Builder addAllWarnings(Iterable<? extends Warnings> values)

[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
NameDescription
valuesIterable<? extends com.google.cloud.compute.v1.Warnings>
Returns
TypeDescription
Operation.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Operation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Operation.Builder
Overrides

addWarnings(Warnings value)

public Operation.Builder addWarnings(Warnings value)

[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
NameDescription
valueWarnings
Returns
TypeDescription
Operation.Builder

addWarnings(Warnings.Builder builderForValue)

public Operation.Builder addWarnings(Warnings.Builder builderForValue)

[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
NameDescription
builderForValueWarnings.Builder
Returns
TypeDescription
Operation.Builder

addWarnings(int index, Warnings value)

public Operation.Builder addWarnings(int index, Warnings value)

[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;

Parameters
NameDescription
indexint
valueWarnings
Returns
TypeDescription
Operation.Builder

addWarnings(int index, Warnings.Builder builderForValue)

public Operation.Builder addWarnings(int index, Warnings.Builder builderForValue)

[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;

Parameters
NameDescription
indexint
builderForValueWarnings.Builder
Returns
TypeDescription
Operation.Builder

addWarningsBuilder()

public Warnings.Builder addWarningsBuilder()

[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
TypeDescription
Warnings.Builder

addWarningsBuilder(int index)

public Warnings.Builder addWarningsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Warnings.Builder

build()

public Operation build()
Returns
TypeDescription
Operation

buildPartial()

public Operation buildPartial()
Returns
TypeDescription
Operation

clear()

public Operation.Builder clear()
Returns
TypeDescription
Operation.Builder
Overrides

clearClientOperationId()

public Operation.Builder clearClientOperationId()

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

optional string client_operation_id = 297240295;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearCreationTimestamp()

public Operation.Builder clearCreationTimestamp()

[Deprecated] This field is deprecated.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearDescription()

public Operation.Builder clearDescription()

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

optional string description = 422937596;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearEndTime()

public Operation.Builder clearEndTime()

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

optional string end_time = 114938801;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearError()

public Operation.Builder clearError()

[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
TypeDescription
Operation.Builder

clearField(Descriptors.FieldDescriptor field)

public Operation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Operation.Builder
Overrides

clearHttpErrorMessage()

public Operation.Builder clearHttpErrorMessage()

[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
TypeDescription
Operation.Builder

This builder for chaining.

clearHttpErrorStatusCode()

public Operation.Builder clearHttpErrorStatusCode()

[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
TypeDescription
Operation.Builder

This builder for chaining.

clearId()

public Operation.Builder clearId()

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

optional uint64 id = 3355;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearInsertTime()

public Operation.Builder clearInsertTime()

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

optional string insert_time = 433722515;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearKind()

public Operation.Builder clearKind()

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

optional string kind = 3292052;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearName()

public Operation.Builder clearName()

[Output Only] Name of the operation.

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

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Operation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Operation.Builder
Overrides

clearOperationGroupId()

public Operation.Builder clearOperationGroupId()

[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
TypeDescription
Operation.Builder

This builder for chaining.

clearOperationType()

public Operation.Builder clearOperationType()

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

optional string operation_type = 177650450;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearProgress()

public Operation.Builder clearProgress()

[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
TypeDescription
Operation.Builder

This builder for chaining.

clearRegion()

public Operation.Builder clearRegion()

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

optional string region = 138946292;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

public Operation.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearStartTime()

public Operation.Builder clearStartTime()

[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
TypeDescription
Operation.Builder

This builder for chaining.

clearStatus()

public Operation.Builder clearStatus()

[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
TypeDescription
Operation.Builder

This builder for chaining.

clearStatusMessage()

public Operation.Builder clearStatusMessage()

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

optional string status_message = 297428154;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearTargetId()

public Operation.Builder clearTargetId()

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

optional uint64 target_id = 258165385;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

public Operation.Builder clearTargetLink()

[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
TypeDescription
Operation.Builder

This builder for chaining.

clearUser()

public Operation.Builder clearUser()

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

optional string user = 3599307;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clearWarnings()

public Operation.Builder clearWarnings()

[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
TypeDescription
Operation.Builder

clearZone()

public Operation.Builder clearZone()

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

optional string zone = 3744684;

Returns
TypeDescription
Operation.Builder

This builder for chaining.

clone()

public Operation.Builder clone()
Returns
TypeDescription
Operation.Builder
Overrides

getClientOperationId()

public 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
TypeDescription
String

The clientOperationId.

getClientOperationIdBytes()

public 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
TypeDescription
ByteString

The bytes for clientOperationId.

getCreationTimestamp()

public String getCreationTimestamp()

[Deprecated] This field is deprecated.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Deprecated] This field is deprecated.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Operation getDefaultInstanceForType()
Returns
TypeDescription
Operation

getDescription()

public String getDescription()

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

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

optional string description = 422937596;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndTime()

public String getEndTime()

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

optional string end_time = 114938801;

Returns
TypeDescription
String

The endTime.

getEndTimeBytes()

public ByteString getEndTimeBytes()

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

optional string end_time = 114938801;

Returns
TypeDescription
ByteString

The bytes for endTime.

getError()

public 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
TypeDescription
Error

The error.

getErrorBuilder()

public Error.Builder getErrorBuilder()

[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
TypeDescription
Error.Builder

getErrorOrBuilder()

public 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
TypeDescription
ErrorOrBuilder

getHttpErrorMessage()

public 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
TypeDescription
String

The httpErrorMessage.

getHttpErrorMessageBytes()

public 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
TypeDescription
ByteString

The bytes for httpErrorMessage.

getHttpErrorStatusCode()

public 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
TypeDescription
int

The httpErrorStatusCode.

getId()

public long getId()

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

optional uint64 id = 3355;

Returns
TypeDescription
long

The id.

getInsertTime()

public String getInsertTime()

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

optional string insert_time = 433722515;

Returns
TypeDescription
String

The insertTime.

getInsertTimeBytes()

public ByteString getInsertTimeBytes()

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

optional string insert_time = 433722515;

Returns
TypeDescription
ByteString

The bytes for insertTime.

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
TypeDescription
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
TypeDescription
ByteString

The bytes for kind.

getName()

public String getName()

[Output Only] Name of the operation.

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

[Output Only] Name of the operation.

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

Returns
TypeDescription
ByteString

The bytes for name.

getOperationGroupId()

public 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
TypeDescription
String

The operationGroupId.

getOperationGroupIdBytes()

public 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
TypeDescription
ByteString

The bytes for operationGroupId.

getOperationType()

public String getOperationType()

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

optional string operation_type = 177650450;

Returns
TypeDescription
String

The operationType.

getOperationTypeBytes()

public ByteString getOperationTypeBytes()

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

optional string operation_type = 177650450;

Returns
TypeDescription
ByteString

The bytes for operationType.

getProgress()

public 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
TypeDescription
int

The progress.

getRegion()

public String getRegion()

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

optional string region = 138946292;

Returns
TypeDescription
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

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

optional string region = 138946292;

Returns
TypeDescription
ByteString

The bytes for region.

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getStartTime()

public 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
TypeDescription
String

The startTime.

getStartTimeBytes()

public 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
TypeDescription
ByteString

The bytes for startTime.

getStatus()

public 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
TypeDescription
Operation.Status

The status.

getStatusMessage()

public String getStatusMessage()

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

optional string status_message = 297428154;

Returns
TypeDescription
String

The statusMessage.

getStatusMessageBytes()

public ByteString getStatusMessageBytes()

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

optional string status_message = 297428154;

Returns
TypeDescription
ByteString

The bytes for statusMessage.

getStatusValue()

public 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
TypeDescription
int

The enum numeric value on the wire for status.

getTargetId()

public long getTargetId()

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

optional uint64 target_id = 258165385;

Returns
TypeDescription
long

The targetId.

public 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
TypeDescription
String

The targetLink.

getTargetLinkBytes()

public 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
TypeDescription
ByteString

The bytes for targetLink.

getUser()

public String getUser()

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

optional string user = 3599307;

Returns
TypeDescription
String

The user.

getUserBytes()

public ByteString getUserBytes()

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

optional string user = 3599307;

Returns
TypeDescription
ByteString

The bytes for user.

getWarnings(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
Warnings

getWarningsBuilder(int index)

public Warnings.Builder getWarningsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Warnings.Builder

getWarningsBuilderList()

public List<Warnings.Builder> getWarningsBuilderList()

[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
TypeDescription
List<Builder>

getWarningsCount()

public 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
TypeDescription
int

getWarningsList()

public 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
TypeDescription
List<Warnings>

getWarningsOrBuilder(int index)

public 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
NameDescription
indexint
Returns
TypeDescription
WarningsOrBuilder

getWarningsOrBuilderList()

public 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
TypeDescription
List<? extends com.google.cloud.compute.v1.WarningsOrBuilder>

getZone()

public 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
TypeDescription
String

The zone.

getZoneBytes()

public 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
TypeDescription
ByteString

The bytes for zone.

hasClientOperationId()

public 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
TypeDescription
boolean

Whether the clientOperationId field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Deprecated] This field is deprecated.

optional string creation_timestamp = 30525366;

Returns
TypeDescription
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

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

optional string description = 422937596;

Returns
TypeDescription
boolean

Whether the description field is set.

hasEndTime()

public boolean hasEndTime()

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

optional string end_time = 114938801;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasError()

public 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
TypeDescription
boolean

Whether the error field is set.

hasHttpErrorMessage()

public 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
TypeDescription
boolean

Whether the httpErrorMessage field is set.

hasHttpErrorStatusCode()

public 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
TypeDescription
boolean

Whether the httpErrorStatusCode field is set.

hasId()

public boolean hasId()

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

optional uint64 id = 3355;

Returns
TypeDescription
boolean

Whether the id field is set.

hasInsertTime()

public boolean hasInsertTime()

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

optional string insert_time = 433722515;

Returns
TypeDescription
boolean

Whether the insertTime field is set.

hasKind()

public boolean hasKind()

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

optional string kind = 3292052;

Returns
TypeDescription
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

[Output Only] Name of the operation.

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

Returns
TypeDescription
boolean

Whether the name field is set.

hasOperationGroupId()

public 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
TypeDescription
boolean

Whether the operationGroupId field is set.

hasOperationType()

public boolean hasOperationType()

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

optional string operation_type = 177650450;

Returns
TypeDescription
boolean

Whether the operationType field is set.

hasProgress()

public 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
TypeDescription
boolean

Whether the progress field is set.

hasRegion()

public boolean hasRegion()

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

optional string region = 138946292;

Returns
TypeDescription
boolean

Whether the region field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
boolean

Whether the selfLink field is set.

hasStartTime()

public 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
TypeDescription
boolean

Whether the startTime field is set.

hasStatus()

public 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
TypeDescription
boolean

Whether the status field is set.

hasStatusMessage()

public boolean hasStatusMessage()

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

optional string status_message = 297428154;

Returns
TypeDescription
boolean

Whether the statusMessage field is set.

hasTargetId()

public boolean hasTargetId()

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

optional uint64 target_id = 258165385;

Returns
TypeDescription
boolean

Whether the targetId field is set.

public 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
TypeDescription
boolean

Whether the targetLink field is set.

hasUser()

public boolean hasUser()

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

optional string user = 3599307;

Returns
TypeDescription
boolean

Whether the user field is set.

hasZone()

public 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
TypeDescription
boolean

Whether the zone field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeError(Error value)

public Operation.Builder mergeError(Error value)

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

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

Parameter
NameDescription
valueError
Returns
TypeDescription
Operation.Builder

mergeFrom(Operation other)

public Operation.Builder mergeFrom(Operation other)
Parameter
NameDescription
otherOperation
Returns
TypeDescription
Operation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Operation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Operation.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Operation.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Operation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Operation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Operation.Builder
Overrides

removeWarnings(int index)

public Operation.Builder removeWarnings(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
NameDescription
indexint
Returns
TypeDescription
Operation.Builder

setClientOperationId(String value)

public Operation.Builder setClientOperationId(String value)

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

optional string client_operation_id = 297240295;

Parameter
NameDescription
valueString

The clientOperationId to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setClientOperationIdBytes(ByteString value)

public Operation.Builder setClientOperationIdBytes(ByteString value)

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

optional string client_operation_id = 297240295;

Parameter
NameDescription
valueByteString

The bytes for clientOperationId to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setCreationTimestamp(String value)

public Operation.Builder setCreationTimestamp(String value)

[Deprecated] This field is deprecated.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueString

The creationTimestamp to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public Operation.Builder setCreationTimestampBytes(ByteString value)

[Deprecated] This field is deprecated.

optional string creation_timestamp = 30525366;

Parameter
NameDescription
valueByteString

The bytes for creationTimestamp to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setDescription(String value)

public Operation.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Operation.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setEndTime(String value)

public Operation.Builder setEndTime(String value)

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

optional string end_time = 114938801;

Parameter
NameDescription
valueString

The endTime to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setEndTimeBytes(ByteString value)

public Operation.Builder setEndTimeBytes(ByteString value)

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

optional string end_time = 114938801;

Parameter
NameDescription
valueByteString

The bytes for endTime to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setError(Error value)

public Operation.Builder setError(Error value)

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

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

Parameter
NameDescription
valueError
Returns
TypeDescription
Operation.Builder

setError(Error.Builder builderForValue)

public Operation.Builder setError(Error.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueError.Builder
Returns
TypeDescription
Operation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Operation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Operation.Builder
Overrides

setHttpErrorMessage(String value)

public Operation.Builder setHttpErrorMessage(String value)

[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];

Parameter
NameDescription
valueString

The httpErrorMessage to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setHttpErrorMessageBytes(ByteString value)

public Operation.Builder setHttpErrorMessageBytes(ByteString value)

[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];

Parameter
NameDescription
valueByteString

The bytes for httpErrorMessage to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setHttpErrorStatusCode(int value)

public Operation.Builder setHttpErrorStatusCode(int value)

[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];

Parameter
NameDescription
valueint

The httpErrorStatusCode to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setId(long value)

public Operation.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
NameDescription
valuelong

The id to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setInsertTime(String value)

public Operation.Builder setInsertTime(String value)

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

optional string insert_time = 433722515;

Parameter
NameDescription
valueString

The insertTime to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setInsertTimeBytes(ByteString value)

public Operation.Builder setInsertTimeBytes(ByteString value)

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

optional string insert_time = 433722515;

Parameter
NameDescription
valueByteString

The bytes for insertTime to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setKind(String value)

public Operation.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueString

The kind to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setKindBytes(ByteString value)

public Operation.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
NameDescription
valueByteString

The bytes for kind to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setName(String value)

public Operation.Builder setName(String value)

[Output Only] Name of the operation.

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Operation.Builder setNameBytes(ByteString value)

[Output Only] Name of the operation.

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setOperationGroupId(String value)

public Operation.Builder setOperationGroupId(String value)

[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;

Parameter
NameDescription
valueString

The operationGroupId to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setOperationGroupIdBytes(ByteString value)

public Operation.Builder setOperationGroupIdBytes(ByteString value)

[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;

Parameter
NameDescription
valueByteString

The bytes for operationGroupId to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setOperationType(String value)

public Operation.Builder setOperationType(String value)

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

optional string operation_type = 177650450;

Parameter
NameDescription
valueString

The operationType to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setOperationTypeBytes(ByteString value)

public Operation.Builder setOperationTypeBytes(ByteString value)

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

optional string operation_type = 177650450;

Parameter
NameDescription
valueByteString

The bytes for operationType to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setProgress(int value)

public Operation.Builder setProgress(int value)

[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;

Parameter
NameDescription
valueint

The progress to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setRegion(String value)

public Operation.Builder setRegion(String value)

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

optional string region = 138946292;

Parameter
NameDescription
valueString

The region to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public Operation.Builder setRegionBytes(ByteString value)

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

optional string region = 138946292;

Parameter
NameDescription
valueByteString

The bytes for region to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Operation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Operation.Builder
Overrides
public Operation.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueString

The selfLink to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public Operation.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
NameDescription
valueByteString

The bytes for selfLink to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setStartTime(String value)

public Operation.Builder setStartTime(String value)

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

optional string start_time = 37467274;

Parameter
NameDescription
valueString

The startTime to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setStartTimeBytes(ByteString value)

public Operation.Builder setStartTimeBytes(ByteString value)

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

optional string start_time = 37467274;

Parameter
NameDescription
valueByteString

The bytes for startTime to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setStatus(Operation.Status value)

public Operation.Builder setStatus(Operation.Status value)

[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];

Parameter
NameDescription
valueOperation.Status

The status to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setStatusMessage(String value)

public Operation.Builder setStatusMessage(String value)

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

optional string status_message = 297428154;

Parameter
NameDescription
valueString

The statusMessage to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setStatusMessageBytes(ByteString value)

public Operation.Builder setStatusMessageBytes(ByteString value)

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

optional string status_message = 297428154;

Parameter
NameDescription
valueByteString

The bytes for statusMessage to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setStatusValue(int value)

public Operation.Builder setStatusValue(int value)

[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];

Parameter
NameDescription
valueint

The enum numeric value on the wire for status to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setTargetId(long value)

public Operation.Builder setTargetId(long value)

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

optional uint64 target_id = 258165385;

Parameter
NameDescription
valuelong

The targetId to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

public Operation.Builder setTargetLink(String value)

[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;

Parameter
NameDescription
valueString

The targetLink to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setTargetLinkBytes(ByteString value)

public Operation.Builder setTargetLinkBytes(ByteString value)

[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;

Parameter
NameDescription
valueByteString

The bytes for targetLink to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Operation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Operation.Builder
Overrides

setUser(String value)

public Operation.Builder setUser(String value)

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

optional string user = 3599307;

Parameter
NameDescription
valueString

The user to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setUserBytes(ByteString value)

public Operation.Builder setUserBytes(ByteString value)

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

optional string user = 3599307;

Parameter
NameDescription
valueByteString

The bytes for user to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setWarnings(int index, Warnings value)

public Operation.Builder setWarnings(int index, Warnings value)

[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;

Parameters
NameDescription
indexint
valueWarnings
Returns
TypeDescription
Operation.Builder

setWarnings(int index, Warnings.Builder builderForValue)

public Operation.Builder setWarnings(int index, Warnings.Builder builderForValue)

[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;

Parameters
NameDescription
indexint
builderForValueWarnings.Builder
Returns
TypeDescription
Operation.Builder

setZone(String value)

public Operation.Builder setZone(String value)

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

optional string zone = 3744684;

Parameter
NameDescription
valueString

The zone to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.

setZoneBytes(ByteString value)

public Operation.Builder setZoneBytes(ByteString value)

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

optional string zone = 3744684;

Parameter
NameDescription
valueByteString

The bytes for zone to set.

Returns
TypeDescription
Operation.Builder

This builder for chaining.