public final class OperationMetadata extends GeneratedMessageV3 implements OperationMetadataOrBuilder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.functions.v2beta.OperationMetadata
Static Fields
public static final int API_VERSION_FIELD_NUMBER
Field Value
public static final int CANCEL_REQUESTED_FIELD_NUMBER
Field Value
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int END_TIME_FIELD_NUMBER
Field Value
public static final int REQUEST_RESOURCE_FIELD_NUMBER
Field Value
public static final int STAGES_FIELD_NUMBER
Field Value
public static final int STATUS_DETAIL_FIELD_NUMBER
Field Value
public static final int TARGET_FIELD_NUMBER
Field Value
public static final int VERB_FIELD_NUMBER
Field Value
Static Methods
public static OperationMetadata getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static OperationMetadata.Builder newBuilder()
Returns
public static OperationMetadata.Builder newBuilder(OperationMetadata prototype)
Parameter
Returns
public static OperationMetadata parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static OperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static OperationMetadata parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static OperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static OperationMetadata parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static OperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static OperationMetadata parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static OperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static OperationMetadata parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static OperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static OperationMetadata parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static OperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<OperationMetadata> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public String getApiVersion()
API version used to start the operation.
string api_version = 7;
Returns
Type | Description |
String | The apiVersion.
|
public ByteString getApiVersionBytes()
API version used to start the operation.
string api_version = 7;
Returns
Type | Description |
ByteString | The bytes for apiVersion.
|
public boolean getCancelRequested()
Identifies whether the user has requested cancellation
of the operation. Operations that have successfully been cancelled
have [Operation.error][] value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED
.
bool cancel_requested = 6;
Returns
Type | Description |
boolean | The cancelRequested.
|
public Timestamp getCreateTime()
The time the operation was created.
.google.protobuf.Timestamp create_time = 1;
Returns
public TimestampOrBuilder getCreateTimeOrBuilder()
The time the operation was created.
.google.protobuf.Timestamp create_time = 1;
Returns
public OperationMetadata getDefaultInstanceForType()
Returns
public Timestamp getEndTime()
The time the operation finished running.
.google.protobuf.Timestamp end_time = 2;
Returns
public TimestampOrBuilder getEndTimeOrBuilder()
The time the operation finished running.
.google.protobuf.Timestamp end_time = 2;
Returns
public Parser<OperationMetadata> getParserForType()
Returns
Overrides
public Any getRequestResource()
The original request that started the operation.
.google.protobuf.Any request_resource = 8;
Returns
Type | Description |
Any | The requestResource.
|
public AnyOrBuilder getRequestResourceOrBuilder()
The original request that started the operation.
.google.protobuf.Any request_resource = 8;
Returns
public int getSerializedSize()
Returns
Overrides
public Stage getStages(int index)
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2beta.Stage stages = 9;
Parameter
Returns
public int getStagesCount()
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2beta.Stage stages = 9;
Returns
public List<Stage> getStagesList()
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2beta.Stage stages = 9;
Returns
public StageOrBuilder getStagesOrBuilder(int index)
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2beta.Stage stages = 9;
Parameter
Returns
public List<? extends StageOrBuilder> getStagesOrBuilderList()
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2beta.Stage stages = 9;
Returns
Type | Description |
List<? extends com.google.cloud.functions.v2beta.StageOrBuilder> | |
public String getStatusDetail()
Human-readable status of the operation, if any.
string status_detail = 5;
Returns
Type | Description |
String | The statusDetail.
|
public ByteString getStatusDetailBytes()
Human-readable status of the operation, if any.
string status_detail = 5;
Returns
Type | Description |
ByteString | The bytes for statusDetail.
|
public String getTarget()
Server-defined resource path for the target of the operation.
string target = 3;
Returns
Type | Description |
String | The target.
|
public ByteString getTargetBytes()
Server-defined resource path for the target of the operation.
string target = 3;
Returns
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
Name of the verb executed by the operation.
string verb = 4;
Returns
Type | Description |
String | The verb.
|
public ByteString getVerbBytes()
Name of the verb executed by the operation.
string verb = 4;
Returns
public boolean hasCreateTime()
The time the operation was created.
.google.protobuf.Timestamp create_time = 1;
Returns
Type | Description |
boolean | Whether the createTime field is set.
|
public boolean hasEndTime()
The time the operation finished running.
.google.protobuf.Timestamp end_time = 2;
Returns
Type | Description |
boolean | Whether the endTime field is set.
|
public boolean hasRequestResource()
The original request that started the operation.
.google.protobuf.Any request_resource = 8;
Returns
Type | Description |
boolean | Whether the requestResource field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public OperationMetadata.Builder newBuilderForType()
Returns
protected OperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public OperationMetadata.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions