public final class OperationMetadata extends GeneratedMessageV3 implements OperationMetadataOrBuilder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.functions.v2.OperationMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int API_VERSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int BUILD_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CANCEL_REQUESTED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int OPERATION_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int REQUEST_RESOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SOURCE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STAGES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STATUS_DETAIL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TARGET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int VERB_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static OperationMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static OperationMetadata.Builder newBuilder()
public static OperationMetadata.Builder newBuilder(OperationMetadata prototype)
public static OperationMetadata parseDelimitedFrom(InputStream input)
public static OperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OperationMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static OperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static OperationMetadata parseFrom(ByteString data)
public static OperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static OperationMetadata parseFrom(CodedInputStream input)
public static OperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static OperationMetadata parseFrom(InputStream input)
public static OperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OperationMetadata parseFrom(ByteBuffer data)
public static OperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<OperationMetadata> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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 String getBuildName()
The build name of the function for create and update operations.
string build_name = 13;
| Returns |
| Type |
Description |
String |
The buildName.
|
public ByteString getBuildNameBytes()
The build name of the function for create and update operations.
string build_name = 13;
| Returns |
| Type |
Description |
ByteString |
The bytes for buildName.
|
public boolean getCancelRequested()
Identifies whether the user has requested cancellation
of the operation. Operations that have successfully been cancelled
have
google.longrunning.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 |
| Type |
Description |
Timestamp |
The createTime.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
The time the operation was created.
.google.protobuf.Timestamp create_time = 1;
public OperationMetadata getDefaultInstanceForType()
public Timestamp getEndTime()
The time the operation finished running.
.google.protobuf.Timestamp end_time = 2;
| Returns |
| Type |
Description |
Timestamp |
The endTime.
|
public TimestampOrBuilder getEndTimeOrBuilder()
The time the operation finished running.
.google.protobuf.Timestamp end_time = 2;
public OperationType getOperationType()
The operation type.
.google.cloud.functions.v2.OperationType operation_type = 11;
public int getOperationTypeValue()
The operation type.
.google.cloud.functions.v2.OperationType operation_type = 11;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for operationType.
|
public Parser<OperationMetadata> getParserForType()
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;
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public String getSourceToken()
An identifier for Firebase function sources. Disclaimer: This field is only
supported for Firebase function deployments.
string source_token = 10;
| Returns |
| Type |
Description |
String |
The sourceToken.
|
public ByteString getSourceTokenBytes()
An identifier for Firebase function sources. Disclaimer: This field is only
supported for Firebase function deployments.
string source_token = 10;
| Returns |
| Type |
Description |
ByteString |
The bytes for sourceToken.
|
public Stage getStages(int index)
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2.Stage stages = 9;
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
Stage |
|
public int getStagesCount()
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2.Stage stages = 9;
| Returns |
| Type |
Description |
int |
|
public List<Stage> getStagesList()
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2.Stage stages = 9;
public StageOrBuilder getStagesOrBuilder(int index)
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2.Stage stages = 9;
| Parameter |
| Name |
Description |
index |
int
|
public List<? extends StageOrBuilder> getStagesOrBuilderList()
Mechanism for reporting in-progress stages
repeated .google.cloud.functions.v2.Stage stages = 9;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.functions.v2.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 |
| Type |
Description |
ByteString |
The bytes for target.
|
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 |
| Type |
Description |
ByteString |
The bytes for verb.
|
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 |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public OperationMetadata.Builder newBuilderForType()
protected OperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public OperationMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
