- 2.82.0 (latest)
 - 2.80.0
 - 2.79.0
 - 2.78.0
 - 2.77.0
 - 2.76.0
 - 2.74.0
 - 2.72.0
 - 2.71.0
 - 2.68.0
 - 2.67.0
 - 2.66.0
 - 2.64.0
 - 2.63.0
 - 2.62.0
 - 2.61.0
 - 2.60.0
 - 2.59.0
 - 2.58.0
 - 2.57.0
 - 2.56.0
 - 2.55.0
 - 2.53.0
 - 2.52.0
 - 2.51.0
 - 2.50.0
 - 2.49.0
 - 2.48.0
 - 2.47.0
 - 2.46.0
 - 2.45.0
 - 2.44.0
 - 2.43.0
 - 2.41.0
 - 2.40.0
 - 2.39.0
 - 2.38.0
 - 2.37.0
 - 2.36.0
 - 2.35.0
 - 2.34.0
 - 2.33.0
 - 2.32.0
 - 2.31.0
 - 2.28.0
 - 2.27.0
 - 2.26.0
 - 2.25.0
 - 2.24.0
 - 2.23.0
 - 2.22.0
 - 2.21.0
 - 2.20.0
 - 2.19.0
 - 2.18.0
 - 2.17.0
 - 2.16.0
 - 2.15.0
 - 2.13.0
 - 2.12.0
 - 2.11.0
 - 2.10.0
 - 2.9.0
 - 2.8.0
 - 2.7.5
 - 2.6.2
 - 2.5.1
 - 2.4.3
 - 2.3.1
 - 2.2.1
 - 2.1.9
 
public static final class CommonOperationMetadata.Builder extends GeneratedMessageV3.Builder<CommonOperationMetadata.Builder> implements CommonOperationMetadataOrBuilderThe common metadata for long running operations.
 Protobuf type google.cloud.documentai.v1.CommonOperationMetadata
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CommonOperationMetadata.BuilderImplements
CommonOperationMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CommonOperationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
build()
public CommonOperationMetadata build()| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata | 
        |
buildPartial()
public CommonOperationMetadata buildPartial()| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata | 
        |
clear()
public CommonOperationMetadata.Builder clear()| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
clearCreateTime()
public CommonOperationMetadata.Builder clearCreateTime()The creation time of the operation.
 .google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
clearField(Descriptors.FieldDescriptor field)
public CommonOperationMetadata.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
clearOneof(Descriptors.OneofDescriptor oneof)
public CommonOperationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description | 
oneof | 
        OneofDescriptor | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
clearResource()
public CommonOperationMetadata.Builder clearResource()A related resource to this operation.
 string resource = 5;
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        This builder for chaining.  | 
      
clearState()
public CommonOperationMetadata.Builder clearState()The state of the operation.
 .google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        This builder for chaining.  | 
      
clearStateMessage()
public CommonOperationMetadata.Builder clearStateMessage()A message providing more details about the current state of processing.
 string state_message = 2;
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        This builder for chaining.  | 
      
clearUpdateTime()
public CommonOperationMetadata.Builder clearUpdateTime()The last update time of the operation.
 .google.protobuf.Timestamp update_time = 4;
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
clone()
public CommonOperationMetadata.Builder clone()| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
getCreateTime()
public Timestamp getCreateTime()The creation time of the operation.
 .google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description | 
Timestamp | 
        The createTime.  | 
      
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()The creation time of the operation.
 .google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description | 
Builder | 
        |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()The creation time of the operation.
 .google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description | 
TimestampOrBuilder | 
        |
getDefaultInstanceForType()
public CommonOperationMetadata getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata | 
        |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description | 
Descriptor | 
        |
getResource()
public String getResource()A related resource to this operation.
 string resource = 5;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The resource.  | 
      
getResourceBytes()
public ByteString getResourceBytes()A related resource to this operation.
 string resource = 5;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for resource.  | 
      
getState()
public CommonOperationMetadata.State getState()The state of the operation.
 .google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.State | 
        The state.  | 
      
getStateMessage()
public String getStateMessage()A message providing more details about the current state of processing.
 string state_message = 2;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The stateMessage.  | 
      
getStateMessageBytes()
public ByteString getStateMessageBytes()A message providing more details about the current state of processing.
 string state_message = 2;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for stateMessage.  | 
      
getStateValue()
public int getStateValue()The state of the operation.
 .google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;
| Returns | |
|---|---|
| Type | Description | 
int | 
        The enum numeric value on the wire for state.  | 
      
getUpdateTime()
public Timestamp getUpdateTime()The last update time of the operation.
 .google.protobuf.Timestamp update_time = 4;
| Returns | |
|---|---|
| Type | Description | 
Timestamp | 
        The updateTime.  | 
      
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()The last update time of the operation.
 .google.protobuf.Timestamp update_time = 4;
| Returns | |
|---|---|
| Type | Description | 
Builder | 
        |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()The last update time of the operation.
 .google.protobuf.Timestamp update_time = 4;
| Returns | |
|---|---|
| Type | Description | 
TimestampOrBuilder | 
        |
hasCreateTime()
public boolean hasCreateTime()The creation time of the operation.
 .google.protobuf.Timestamp create_time = 3;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the createTime field is set.  | 
      
hasUpdateTime()
public boolean hasUpdateTime()The last update time of the operation.
 .google.protobuf.Timestamp update_time = 4;
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the updateTime field is set.  | 
      
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description | 
FieldAccessorTable | 
        |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
mergeCreateTime(Timestamp value)
public CommonOperationMetadata.Builder mergeCreateTime(Timestamp value)The creation time of the operation.
 .google.protobuf.Timestamp create_time = 3;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        Timestamp | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
mergeFrom(CommonOperationMetadata other)
public CommonOperationMetadata.Builder mergeFrom(CommonOperationMetadata other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        CommonOperationMetadata | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CommonOperationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description | 
input | 
        CodedInputStream | 
      
extensionRegistry | 
        ExtensionRegistryLite | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
| Exceptions | |
|---|---|
| Type | Description | 
IOException | 
        |
mergeFrom(Message other)
public CommonOperationMetadata.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description | 
other | 
        Message | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CommonOperationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
mergeUpdateTime(Timestamp value)
public CommonOperationMetadata.Builder mergeUpdateTime(Timestamp value)The last update time of the operation.
 .google.protobuf.Timestamp update_time = 4;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        Timestamp | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
setCreateTime(Timestamp value)
public CommonOperationMetadata.Builder setCreateTime(Timestamp value)The creation time of the operation.
 .google.protobuf.Timestamp create_time = 3;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        Timestamp | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
setCreateTime(Timestamp.Builder builderForValue)
public CommonOperationMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)The creation time of the operation.
 .google.protobuf.Timestamp create_time = 3;
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
setField(Descriptors.FieldDescriptor field, Object value)
public CommonOperationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CommonOperationMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description | 
field | 
        FieldDescriptor | 
      
index | 
        int | 
      
value | 
        Object | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
setResource(String value)
public CommonOperationMetadata.Builder setResource(String value)A related resource to this operation.
 string resource = 5;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe resource to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        This builder for chaining.  | 
      
setResourceBytes(ByteString value)
public CommonOperationMetadata.Builder setResourceBytes(ByteString value)A related resource to this operation.
 string resource = 5;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for resource to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        This builder for chaining.  | 
      
setState(CommonOperationMetadata.State value)
public CommonOperationMetadata.Builder setState(CommonOperationMetadata.State value)The state of the operation.
 .google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        CommonOperationMetadata.StateThe state to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        This builder for chaining.  | 
      
setStateMessage(String value)
public CommonOperationMetadata.Builder setStateMessage(String value)A message providing more details about the current state of processing.
 string state_message = 2;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        StringThe stateMessage to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        This builder for chaining.  | 
      
setStateMessageBytes(ByteString value)
public CommonOperationMetadata.Builder setStateMessageBytes(ByteString value)A message providing more details about the current state of processing.
 string state_message = 2;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        ByteStringThe bytes for stateMessage to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        This builder for chaining.  | 
      
setStateValue(int value)
public CommonOperationMetadata.Builder setStateValue(int value)The state of the operation.
 .google.cloud.documentai.v1.CommonOperationMetadata.State state = 1;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        intThe enum numeric value on the wire for state to set.  | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        This builder for chaining.  | 
      
setUnknownFields(UnknownFieldSet unknownFields)
public final CommonOperationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description | 
unknownFields | 
        UnknownFieldSet | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
setUpdateTime(Timestamp value)
public CommonOperationMetadata.Builder setUpdateTime(Timestamp value)The last update time of the operation.
 .google.protobuf.Timestamp update_time = 4;
| Parameter | |
|---|---|
| Name | Description | 
value | 
        Timestamp | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |
setUpdateTime(Timestamp.Builder builderForValue)
public CommonOperationMetadata.Builder setUpdateTime(Timestamp.Builder builderForValue)The last update time of the operation.
 .google.protobuf.Timestamp update_time = 4;
| Parameter | |
|---|---|
| Name | Description | 
builderForValue | 
        Builder | 
      
| Returns | |
|---|---|
| Type | Description | 
CommonOperationMetadata.Builder | 
        |