Class OperationMetadata.Builder

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.notebooks.v1.OperationMetadata

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OperationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OperationMetadata.Builder
Overrides

build()

public OperationMetadata build()
Returns
TypeDescription
OperationMetadata

buildPartial()

public OperationMetadata buildPartial()
Returns
TypeDescription
OperationMetadata

clear()

public OperationMetadata.Builder clear()
Returns
TypeDescription
OperationMetadata.Builder
Overrides

clearApiVersion()

public OperationMetadata.Builder clearApiVersion()

API version used to start the operation.

string api_version = 7;

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

clearCreateTime()

public OperationMetadata.Builder clearCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
OperationMetadata.Builder

clearEndTime()

public OperationMetadata.Builder clearEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
OperationMetadata.Builder

clearEndpoint()

public OperationMetadata.Builder clearEndpoint()

API endpoint name of this operation.

string endpoint = 8;

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public OperationMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
OperationMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public OperationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
OperationMetadata.Builder
Overrides

clearRequestedCancellation()

public OperationMetadata.Builder clearRequestedCancellation()

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;

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

clearStatusMessage()

public OperationMetadata.Builder clearStatusMessage()

Human-readable status of the operation, if any.

string status_message = 5;

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

clearTarget()

public OperationMetadata.Builder clearTarget()

Server-defined resource path for the target of the operation.

string target = 3;

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

clearVerb()

public OperationMetadata.Builder clearVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

clone()

public OperationMetadata.Builder clone()
Returns
TypeDescription
OperationMetadata.Builder
Overrides

getApiVersion()

public String getApiVersion()

API version used to start the operation.

string api_version = 7;

Returns
TypeDescription
String

The apiVersion.

getApiVersionBytes()

public ByteString getApiVersionBytes()

API version used to start the operation.

string api_version = 7;

Returns
TypeDescription
ByteString

The bytes for apiVersion.

getCreateTime()

public Timestamp getCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public OperationMetadata getDefaultInstanceForType()
Returns
TypeDescription
OperationMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndTime()

public Timestamp getEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getEndpoint()

public String getEndpoint()

API endpoint name of this operation.

string endpoint = 8;

Returns
TypeDescription
String

The endpoint.

getEndpointBytes()

public ByteString getEndpointBytes()

API endpoint name of this operation.

string endpoint = 8;

Returns
TypeDescription
ByteString

The bytes for endpoint.

getRequestedCancellation()

public boolean getRequestedCancellation()

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;

Returns
TypeDescription
boolean

The requestedCancellation.

getStatusMessage()

public String getStatusMessage()

Human-readable status of the operation, if any.

string status_message = 5;

Returns
TypeDescription
String

The statusMessage.

getStatusMessageBytes()

public ByteString getStatusMessageBytes()

Human-readable status of the operation, if any.

string status_message = 5;

Returns
TypeDescription
ByteString

The bytes for statusMessage.

getTarget()

public String getTarget()

Server-defined resource path for the target of the operation.

string target = 3;

Returns
TypeDescription
String

The target.

getTargetBytes()

public ByteString getTargetBytes()

Server-defined resource path for the target of the operation.

string target = 3;

Returns
TypeDescription
ByteString

The bytes for target.

getVerb()

public String getVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns
TypeDescription
String

The verb.

getVerbBytes()

public ByteString getVerbBytes()

Name of the verb executed by the operation.

string verb = 4;

Returns
TypeDescription
ByteString

The bytes for verb.

hasCreateTime()

public boolean hasCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
boolean

Whether the endTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public OperationMetadata.Builder mergeCreateTime(Timestamp value)

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
OperationMetadata.Builder

mergeEndTime(Timestamp value)

public OperationMetadata.Builder mergeEndTime(Timestamp value)

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
OperationMetadata.Builder

mergeFrom(OperationMetadata other)

public OperationMetadata.Builder mergeFrom(OperationMetadata other)
Parameter
NameDescription
otherOperationMetadata
Returns
TypeDescription
OperationMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OperationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationMetadata.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public OperationMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
OperationMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OperationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OperationMetadata.Builder
Overrides

setApiVersion(String value)

public OperationMetadata.Builder setApiVersion(String value)

API version used to start the operation.

string api_version = 7;

Parameter
NameDescription
valueString

The apiVersion to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setApiVersionBytes(ByteString value)

public OperationMetadata.Builder setApiVersionBytes(ByteString value)

API version used to start the operation.

string api_version = 7;

Parameter
NameDescription
valueByteString

The bytes for apiVersion to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public OperationMetadata.Builder setCreateTime(Timestamp value)

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
OperationMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

public OperationMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
OperationMetadata.Builder

setEndTime(Timestamp value)

public OperationMetadata.Builder setEndTime(Timestamp value)

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
OperationMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public OperationMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
OperationMetadata.Builder

setEndpoint(String value)

public OperationMetadata.Builder setEndpoint(String value)

API endpoint name of this operation.

string endpoint = 8;

Parameter
NameDescription
valueString

The endpoint to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setEndpointBytes(ByteString value)

public OperationMetadata.Builder setEndpointBytes(ByteString value)

API endpoint name of this operation.

string endpoint = 8;

Parameter
NameDescription
valueByteString

The bytes for endpoint to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public OperationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OperationMetadata.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public OperationMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
OperationMetadata.Builder
Overrides

setRequestedCancellation(boolean value)

public OperationMetadata.Builder setRequestedCancellation(boolean value)

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;

Parameter
NameDescription
valueboolean

The requestedCancellation to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setStatusMessage(String value)

public OperationMetadata.Builder setStatusMessage(String value)

Human-readable status of the operation, if any.

string status_message = 5;

Parameter
NameDescription
valueString

The statusMessage to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setStatusMessageBytes(ByteString value)

public OperationMetadata.Builder setStatusMessageBytes(ByteString value)

Human-readable status of the operation, if any.

string status_message = 5;

Parameter
NameDescription
valueByteString

The bytes for statusMessage to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setTarget(String value)

public OperationMetadata.Builder setTarget(String value)

Server-defined resource path for the target of the operation.

string target = 3;

Parameter
NameDescription
valueString

The target to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setTargetBytes(ByteString value)

public OperationMetadata.Builder setTargetBytes(ByteString value)

Server-defined resource path for the target of the operation.

string target = 3;

Parameter
NameDescription
valueByteString

The bytes for target to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final OperationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OperationMetadata.Builder
Overrides

setVerb(String value)

public OperationMetadata.Builder setVerb(String value)

Name of the verb executed by the operation.

string verb = 4;

Parameter
NameDescription
valueString

The verb to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.

setVerbBytes(ByteString value)

public OperationMetadata.Builder setVerbBytes(ByteString value)

Name of the verb executed by the operation.

string verb = 4;

Parameter
NameDescription
valueByteString

The bytes for verb to set.

Returns
TypeDescription
OperationMetadata.Builder

This builder for chaining.