public static final class OperationMetadata.Builder extends GeneratedMessageV3.Builder<OperationMetadata.Builder> implements OperationMetadataOrBuilder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.backupdr.v1.OperationMetadata
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > OperationMetadata.BuilderImplements
OperationMetadataOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public OperationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
build()
public OperationMetadata build()
Returns | |
---|---|
Type | Description |
OperationMetadata |
buildPartial()
public OperationMetadata buildPartial()
Returns | |
---|---|
Type | Description |
OperationMetadata |
clear()
public OperationMetadata.Builder clear()
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
clearAdditionalInfo()
public OperationMetadata.Builder clearAdditionalInfo()
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
clearApiVersion()
public OperationMetadata.Builder clearApiVersion()
Output only. API version used to start the operation.
string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
clearCreateTime()
public OperationMetadata.Builder clearCreateTime()
Output only. The time the operation was created.
.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
clearEndTime()
public OperationMetadata.Builder clearEndTime()
Output only. The time the operation finished running.
.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
clearField(Descriptors.FieldDescriptor field)
public OperationMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public OperationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
clearRequestedCancellation()
public OperationMetadata.Builder clearRequestedCancellation()
Output only. 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 requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
clearStatusMessage()
public OperationMetadata.Builder clearStatusMessage()
Output only. Human-readable status of the operation, if any.
string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
clearTarget()
public OperationMetadata.Builder clearTarget()
Output only. Server-defined resource path for the target of the operation.
string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
clearVerb()
public OperationMetadata.Builder clearVerb()
Output only. Name of the verb executed by the operation.
string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
clone()
public OperationMetadata.Builder clone()
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
containsAdditionalInfo(String key)
public boolean containsAdditionalInfo(String key)
Output only. AdditionalInfo contains additional Info related to backup plan association resource.
map<string, string> additional_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
getAdditionalInfo() (deprecated)
public Map<String,String> getAdditionalInfo()
Use #getAdditionalInfoMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getAdditionalInfoCount()
public int getAdditionalInfoCount()
Output only. AdditionalInfo contains additional Info related to backup plan association resource.
map<string, string> additional_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
getAdditionalInfoMap()
public Map<String,String> getAdditionalInfoMap()
Output only. AdditionalInfo contains additional Info related to backup plan association resource.
map<string, string> additional_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Map<String,String> |
getAdditionalInfoOrDefault(String key, String defaultValue)
public String getAdditionalInfoOrDefault(String key, String defaultValue)
Output only. AdditionalInfo contains additional Info related to backup plan association resource.
map<string, string> additional_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
Returns | |
---|---|
Type | Description |
String |
getAdditionalInfoOrThrow(String key)
public String getAdditionalInfoOrThrow(String key)
Output only. AdditionalInfo contains additional Info related to backup plan association resource.
map<string, string> additional_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
String |
getApiVersion()
public String getApiVersion()
Output only. API version used to start the operation.
string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The apiVersion. |
getApiVersionBytes()
public ByteString getApiVersionBytes()
Output only. API version used to start the operation.
string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for apiVersion. |
getCreateTime()
public Timestamp getCreateTime()
Output only. The time the operation was created.
.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. The time the operation was created.
.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the operation was created.
.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public OperationMetadata getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
OperationMetadata |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getEndTime()
public Timestamp getEndTime()
Output only. The time the operation finished running.
.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The endTime. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder()
Output only. The time the operation finished running.
.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. The time the operation finished running.
.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getMutableAdditionalInfo() (deprecated)
public Map<String,String> getMutableAdditionalInfo()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getRequestedCancellation()
public boolean getRequestedCancellation()
Output only. 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 requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
The requestedCancellation. |
getStatusMessage()
public String getStatusMessage()
Output only. Human-readable status of the operation, if any.
string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The statusMessage. |
getStatusMessageBytes()
public ByteString getStatusMessageBytes()
Output only. Human-readable status of the operation, if any.
string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for statusMessage. |
getTarget()
public String getTarget()
Output only. Server-defined resource path for the target of the operation.
string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The target. |
getTargetBytes()
public ByteString getTargetBytes()
Output only. Server-defined resource path for the target of the operation.
string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for target. |
getVerb()
public String getVerb()
Output only. Name of the verb executed by the operation.
string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The verb. |
getVerbBytes()
public ByteString getVerbBytes()
Output only. Name of the verb executed by the operation.
string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for verb. |
hasCreateTime()
public boolean hasCreateTime()
Output only. The time the operation was created.
.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the createTime field is set. |
hasEndTime()
public boolean hasEndTime()
Output only. The time the operation finished running.
.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the endTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public OperationMetadata.Builder mergeCreateTime(Timestamp value)
Output only. The time the operation was created.
.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
mergeEndTime(Timestamp value)
public OperationMetadata.Builder mergeEndTime(Timestamp value)
Output only. The time the operation finished running.
.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
mergeFrom(OperationMetadata other)
public OperationMetadata.Builder mergeFrom(OperationMetadata other)
Parameter | |
---|---|
Name | Description |
other |
OperationMetadata |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public OperationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public OperationMetadata.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final OperationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
putAdditionalInfo(String key, String value)
public OperationMetadata.Builder putAdditionalInfo(String key, String value)
Output only. AdditionalInfo contains additional Info related to backup plan association resource.
map<string, string> additional_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
key |
String |
value |
String |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
putAllAdditionalInfo(Map<String,String> values)
public OperationMetadata.Builder putAllAdditionalInfo(Map<String,String> values)
Output only. AdditionalInfo contains additional Info related to backup plan association resource.
map<string, string> additional_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
values |
Map<String,String> |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
removeAdditionalInfo(String key)
public OperationMetadata.Builder removeAdditionalInfo(String key)
Output only. AdditionalInfo contains additional Info related to backup plan association resource.
map<string, string> additional_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
setApiVersion(String value)
public OperationMetadata.Builder setApiVersion(String value)
Output only. API version used to start the operation.
string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The apiVersion to set. |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
setApiVersionBytes(ByteString value)
public OperationMetadata.Builder setApiVersionBytes(ByteString value)
Output only. API version used to start the operation.
string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for apiVersion to set. |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public OperationMetadata.Builder setCreateTime(Timestamp value)
Output only. The time the operation was created.
.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public OperationMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. The time the operation was created.
.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
setEndTime(Timestamp value)
public OperationMetadata.Builder setEndTime(Timestamp value)
Output only. The time the operation finished running.
.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
setEndTime(Timestamp.Builder builderForValue)
public OperationMetadata.Builder setEndTime(Timestamp.Builder builderForValue)
Output only. The time the operation finished running.
.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public OperationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public OperationMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
setRequestedCancellation(boolean value)
public OperationMetadata.Builder setRequestedCancellation(boolean value)
Output only. 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 requested_cancellation = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
boolean The requestedCancellation to set. |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
setStatusMessage(String value)
public OperationMetadata.Builder setStatusMessage(String value)
Output only. Human-readable status of the operation, if any.
string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The statusMessage to set. |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
setStatusMessageBytes(ByteString value)
public OperationMetadata.Builder setStatusMessageBytes(ByteString value)
Output only. Human-readable status of the operation, if any.
string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for statusMessage to set. |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
setTarget(String value)
public OperationMetadata.Builder setTarget(String value)
Output only. Server-defined resource path for the target of the operation.
string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The target to set. |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
setTargetBytes(ByteString value)
public OperationMetadata.Builder setTargetBytes(ByteString value)
Output only. Server-defined resource path for the target of the operation.
string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for target to set. |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final OperationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
setVerb(String value)
public OperationMetadata.Builder setVerb(String value)
Output only. Name of the verb executed by the operation.
string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The verb to set. |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |
setVerbBytes(ByteString value)
public OperationMetadata.Builder setVerbBytes(ByteString value)
Output only. Name of the verb executed by the operation.
string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for verb to set. |
Returns | |
---|---|
Type | Description |
OperationMetadata.Builder |
This builder for chaining. |