Class Operation (2.56.0)

public final class Operation extends GeneratedMessageV3 implements OperationOrBuilder

This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.

Protobuf type google.container.v1.Operation

Implements

OperationOrBuilder

Static Fields

CLUSTER_CONDITIONS_FIELD_NUMBER

public static final int CLUSTER_CONDITIONS_FIELD_NUMBER
Field Value
Type Description
int

DETAIL_FIELD_NUMBER

public static final int DETAIL_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NODEPOOL_CONDITIONS_FIELD_NUMBER

public static final int NODEPOOL_CONDITIONS_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_TYPE_FIELD_NUMBER

public static final int OPERATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PROGRESS_FIELD_NUMBER

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

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

STATUS_MESSAGE_FIELD_NUMBER

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

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Operation getDefaultInstance()
Returns
Type Description
Operation

getDescriptor()

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

newBuilder()

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

newBuilder(Operation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getClusterConditions(int index) (deprecated)

public StatusCondition getClusterConditions(int index)

Which conditions caused the current cluster state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
StatusCondition

getClusterConditionsCount() (deprecated)

public int getClusterConditionsCount()

Which conditions caused the current cluster state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true];

Returns
Type Description
int

getClusterConditionsList() (deprecated)

public List<StatusCondition> getClusterConditionsList()

Which conditions caused the current cluster state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true];

Returns
Type Description
List<StatusCondition>

getClusterConditionsOrBuilder(int index) (deprecated)

public StatusConditionOrBuilder getClusterConditionsOrBuilder(int index)

Which conditions caused the current cluster state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
StatusConditionOrBuilder

getClusterConditionsOrBuilderList() (deprecated)

public List<? extends StatusConditionOrBuilder> getClusterConditionsOrBuilderList()

Which conditions caused the current cluster state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition cluster_conditions = 13 [deprecated = true];

Returns
Type Description
List<? extends com.google.container.v1.StatusConditionOrBuilder>

getDefaultInstanceForType()

public Operation getDefaultInstanceForType()
Returns
Type Description
Operation

getDetail()

public String getDetail()

Output only. Detailed operation progress, if available.

string detail = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The detail.

getDetailBytes()

public ByteString getDetailBytes()

Output only. Detailed operation progress, if available.

string detail = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for detail.

getEndTime()

public String getEndTime()

Output only. The time the operation completed, in RFC3339 text format.

string end_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The endTime.

getEndTimeBytes()

public ByteString getEndTimeBytes()

Output only. The time the operation completed, in RFC3339 text format.

string end_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for endTime.

getError()

public Status getError()

The error result of the operation in case of failure.

.google.rpc.Status error = 15;

Returns
Type Description
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

The error result of the operation in case of failure.

.google.rpc.Status error = 15;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getLocation()

public String getLocation()

Output only. The name of the Google Compute Engine zone or region in which the cluster resides.

string location = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Output only. The name of the Google Compute Engine zone or region in which the cluster resides.

string location = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for location.

getName()

public String getName()

Output only. The server-assigned ID for the operation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The server-assigned ID for the operation.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getNodepoolConditions(int index) (deprecated)

public StatusCondition getNodepoolConditions(int index)

Which conditions caused the current node pool state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
StatusCondition

getNodepoolConditionsCount() (deprecated)

public int getNodepoolConditionsCount()

Which conditions caused the current node pool state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true];

Returns
Type Description
int

getNodepoolConditionsList() (deprecated)

public List<StatusCondition> getNodepoolConditionsList()

Which conditions caused the current node pool state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true];

Returns
Type Description
List<StatusCondition>

getNodepoolConditionsOrBuilder(int index) (deprecated)

public StatusConditionOrBuilder getNodepoolConditionsOrBuilder(int index)

Which conditions caused the current node pool state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
StatusConditionOrBuilder

getNodepoolConditionsOrBuilderList() (deprecated)

public List<? extends StatusConditionOrBuilder> getNodepoolConditionsOrBuilderList()

Which conditions caused the current node pool state. Deprecated. Use field error instead.

repeated .google.container.v1.StatusCondition nodepool_conditions = 14 [deprecated = true];

Returns
Type Description
List<? extends com.google.container.v1.StatusConditionOrBuilder>

getOperationType()

public Operation.Type getOperationType()

Output only. The operation type.

.google.container.v1.Operation.Type operation_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Operation.Type

The operationType.

getOperationTypeValue()

public int getOperationTypeValue()

Output only. The operation type.

.google.container.v1.Operation.Type operation_type = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for operationType.

getParserForType()

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

getProgress()

public OperationProgress getProgress()

Output only. Progress information for an operation.

.google.container.v1.OperationProgress progress = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationProgress

The progress.

getProgressOrBuilder()

public OperationProgressOrBuilder getProgressOrBuilder()

Output only. Progress information for an operation.

.google.container.v1.OperationProgress progress = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationProgressOrBuilder
public String getSelfLink()

Output only. Server-defined URI for the operation. Example: https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123.

string self_link = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

Output only. Server-defined URI for the operation. Example: https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123.

string self_link = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public String getStartTime()

Output only. The time the operation started, in RFC3339 text format.

string start_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The startTime.

getStartTimeBytes()

public ByteString getStartTimeBytes()

Output only. The time the operation started, in RFC3339 text format.

string start_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for startTime.

getStatus()

public Operation.Status getStatus()

Output only. The current status of the operation.

.google.container.v1.Operation.Status status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Operation.Status

The status.

getStatusMessage() (deprecated)

public String getStatusMessage()

Deprecated. google.container.v1.Operation.status_message is deprecated. See google/container/v1/cluster_service.proto;l=2852

Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

string status_message = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The statusMessage.

getStatusMessageBytes() (deprecated)

public ByteString getStatusMessageBytes()

Deprecated. google.container.v1.Operation.status_message is deprecated. See google/container/v1/cluster_service.proto;l=2852

Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.

string status_message = 5 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for statusMessage.

getStatusValue()

public int getStatusValue()

Output only. The current status of the operation.

.google.container.v1.Operation.Status status = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

public String getTargetLink()

Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target.

Examples:

-

#

https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster

#

https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np

https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node

string target_link = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The targetLink.

getTargetLinkBytes()

public ByteString getTargetLinkBytes()

Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target.

Examples:

-

#

https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster

#

https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np

https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node

string target_link = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for targetLink.

getZone() (deprecated)

public String getZone()

Deprecated. google.container.v1.Operation.zone is deprecated. See google/container/v1/cluster_service.proto;l=2838

Output only. The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.

string zone = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The zone.

getZoneBytes() (deprecated)

public ByteString getZoneBytes()

Deprecated. google.container.v1.Operation.zone is deprecated. See google/container/v1/cluster_service.proto;l=2838

Output only. The name of the Google Compute Engine zone in which the operation is taking place. This field is deprecated, use location instead.

string zone = 2 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for zone.

hasError()

public boolean hasError()

The error result of the operation in case of failure.

.google.rpc.Status error = 15;

Returns
Type Description
boolean

Whether the error field is set.

hasProgress()

public boolean hasProgress()

Output only. Progress information for an operation.

.google.container.v1.OperationProgress progress = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the progress field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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