Class Operation (2.36.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
TypeDescription
int

DETAIL_FIELD_NUMBER

public static final int DETAIL_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NODEPOOL_CONDITIONS_FIELD_NUMBER

public static final int NODEPOOL_CONDITIONS_FIELD_NUMBER
Field Value
TypeDescription
int

OPERATION_TYPE_FIELD_NUMBER

public static final int OPERATION_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_MESSAGE_FIELD_NUMBER

public static final int STATUS_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int TARGET_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Operation getDefaultInstance()
Returns
TypeDescription
Operation

getDescriptor()

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

newBuilder()

public static Operation.Builder newBuilder()
Returns
TypeDescription
Operation.Builder

newBuilder(Operation prototype)

public static Operation.Builder newBuilder(Operation prototype)
Parameter
NameDescription
prototypeOperation
Returns
TypeDescription
Operation.Builder

parseDelimitedFrom(InputStream input)

public static Operation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Operation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Operation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Operation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Operation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Operation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Operation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Operation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Operation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Operation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Operation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Operation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Operation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Operation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Operation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Operation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Operation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Operation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Operation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Operation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Operation> parser()
Returns
TypeDescription
Parser<Operation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.container.v1.StatusConditionOrBuilder>

getDefaultInstanceForType()

public Operation getDefaultInstanceForType()
Returns
TypeDescription
Operation

getDetail()

public String getDetail()

Detailed operation progress, if available.

string detail = 8;

Returns
TypeDescription
String

The detail.

getDetailBytes()

public ByteString getDetailBytes()

Detailed operation progress, if available.

string detail = 8;

Returns
TypeDescription
ByteString

The bytes for detail.

getEndTime()

public String getEndTime()

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

string end_time = 11;

Returns
TypeDescription
String

The endTime.

getEndTimeBytes()

public ByteString getEndTimeBytes()

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

string end_time = 11;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for location.

getName()

public String getName()

The server-assigned ID for the operation.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The server-assigned ID for the operation.

string name = 1;

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.container.v1.StatusConditionOrBuilder>

getOperationType()

public Operation.Type getOperationType()

The operation type.

.google.container.v1.Operation.Type operation_type = 3;

Returns
TypeDescription
Operation.Type

The operationType.

getOperationTypeValue()

public int getOperationTypeValue()

The operation type.

.google.container.v1.Operation.Type operation_type = 3;

Returns
TypeDescription
int

The enum numeric value on the wire for operationType.

getParserForType()

public Parser<Operation> getParserForType()
Returns
TypeDescription
Parser<Operation>
Overrides

getProgress()

public OperationProgress getProgress()

Output only. [Output only] Progress information for an operation.

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

Returns
TypeDescription
OperationProgress

The progress.

getProgressOrBuilder()

public OperationProgressOrBuilder getProgressOrBuilder()

Output only. [Output only] Progress information for an operation.

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

Returns
TypeDescription
OperationProgressOrBuilder
public String getSelfLink()

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

string self_link = 6;

Returns
TypeDescription
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

string self_link = 6;

Returns
TypeDescription
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public String getStartTime()

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

string start_time = 10;

Returns
TypeDescription
String

The startTime.

getStartTimeBytes()

public ByteString getStartTimeBytes()

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

string start_time = 10;

Returns
TypeDescription
ByteString

The bytes for startTime.

getStatus()

public Operation.Status getStatus()

The current status of the operation.

.google.container.v1.Operation.Status status = 4;

Returns
TypeDescription
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=2460

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
TypeDescription
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=2460

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

The bytes for statusMessage.

getStatusValue()

public int getStatusValue()

The current status of the operation.

.google.container.v1.Operation.Status status = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for status.

public String getTargetLink()

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;

Returns
TypeDescription
String

The targetLink.

getTargetLinkBytes()

public ByteString getTargetLinkBytes()

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;

Returns
TypeDescription
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=2447

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

Returns
TypeDescription
String

The zone.

getZoneBytes() (deprecated)

public ByteString getZoneBytes()

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

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

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

Whether the error field is set.

hasProgress()

public boolean hasProgress()

Output only. [Output only] Progress information for an operation.

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

Returns
TypeDescription
boolean

Whether the progress field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Operation.Builder newBuilderForType()
Returns
TypeDescription
Operation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Operation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Operation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Operation.Builder toBuilder()
Returns
TypeDescription
Operation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException