Class Execution.Builder (1.42.0)

public static final class Execution.Builder extends GeneratedMessageV3.Builder<Execution.Builder> implements ExecutionOrBuilder

The definition of a single executed notebook.

Protobuf type google.cloud.notebooks.v1.Execution

Implements

ExecutionOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Execution.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Execution.Builder
Overrides

build()

public Execution build()
Returns
Type Description
Execution

buildPartial()

public Execution buildPartial()
Returns
Type Description
Execution

clear()

public Execution.Builder clear()
Returns
Type Description
Execution.Builder
Overrides

clearCreateTime()

public Execution.Builder clearCreateTime()

Output only. Time the Execution was instantiated.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Execution.Builder

clearDescription()

public Execution.Builder clearDescription()

A brief description of this execution.

string description = 4;

Returns
Type Description
Execution.Builder

This builder for chaining.

clearDisplayName()

public Execution.Builder clearDisplayName()

Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Execution.Builder

This builder for chaining.

clearExecutionTemplate()

public Execution.Builder clearExecutionTemplate()

execute metadata including name, hardware spec, region, labels, etc.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;

Returns
Type Description
Execution.Builder

clearField(Descriptors.FieldDescriptor field)

public Execution.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Execution.Builder
Overrides

clearJobUri()

public Execution.Builder clearJobUri()

Output only. The URI of the external job used to execute the notebook.

string job_uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Execution.Builder

This builder for chaining.

clearName()

public Execution.Builder clearName()

Output only. The resource name of the execute. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Execution.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Execution.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Execution.Builder
Overrides

clearOutputNotebookFile()

public Execution.Builder clearOutputNotebookFile()

Output notebook file generated by this execution

string output_notebook_file = 8;

Returns
Type Description
Execution.Builder

This builder for chaining.

clearState()

public Execution.Builder clearState()

Output only. State of the underlying AI Platform job.

.google.cloud.notebooks.v1.Execution.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Execution.Builder

This builder for chaining.

clearUpdateTime()

public Execution.Builder clearUpdateTime()

Output only. Time the Execution was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Execution.Builder

clone()

public Execution.Builder clone()
Returns
Type Description
Execution.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. Time the Execution was instantiated.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time the Execution was instantiated.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time the Execution was instantiated.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Execution getDefaultInstanceForType()
Returns
Type Description
Execution

getDescription()

public String getDescription()

A brief description of this execution.

string description = 4;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A brief description of this execution.

string description = 4;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for displayName.

getExecutionTemplate()

public ExecutionTemplate getExecutionTemplate()

execute metadata including name, hardware spec, region, labels, etc.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;

Returns
Type Description
ExecutionTemplate

The executionTemplate.

getExecutionTemplateBuilder()

public ExecutionTemplate.Builder getExecutionTemplateBuilder()

execute metadata including name, hardware spec, region, labels, etc.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;

Returns
Type Description
ExecutionTemplate.Builder

getExecutionTemplateOrBuilder()

public ExecutionTemplateOrBuilder getExecutionTemplateOrBuilder()

execute metadata including name, hardware spec, region, labels, etc.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;

Returns
Type Description
ExecutionTemplateOrBuilder

getJobUri()

public String getJobUri()

Output only. The URI of the external job used to execute the notebook.

string job_uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The jobUri.

getJobUriBytes()

public ByteString getJobUriBytes()

Output only. The URI of the external job used to execute the notebook.

string job_uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for jobUri.

getName()

public String getName()

Output only. The resource name of the execute. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the execute. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getOutputNotebookFile()

public String getOutputNotebookFile()

Output notebook file generated by this execution

string output_notebook_file = 8;

Returns
Type Description
String

The outputNotebookFile.

getOutputNotebookFileBytes()

public ByteString getOutputNotebookFileBytes()

Output notebook file generated by this execution

string output_notebook_file = 8;

Returns
Type Description
ByteString

The bytes for outputNotebookFile.

getState()

public Execution.State getState()

Output only. State of the underlying AI Platform job.

.google.cloud.notebooks.v1.Execution.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Execution.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the underlying AI Platform job.

.google.cloud.notebooks.v1.Execution.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time the Execution was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Time the Execution was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time the Execution was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time the Execution was instantiated.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasExecutionTemplate()

public boolean hasExecutionTemplate()

execute metadata including name, hardware spec, region, labels, etc.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;

Returns
Type Description
boolean

Whether the executionTemplate field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time the Execution was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Execution.Builder mergeCreateTime(Timestamp value)

Output only. Time the Execution was instantiated.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Execution.Builder

mergeExecutionTemplate(ExecutionTemplate value)

public Execution.Builder mergeExecutionTemplate(ExecutionTemplate value)

execute metadata including name, hardware spec, region, labels, etc.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;

Parameter
Name Description
value ExecutionTemplate
Returns
Type Description
Execution.Builder

mergeFrom(Execution other)

public Execution.Builder mergeFrom(Execution other)
Parameter
Name Description
other Execution
Returns
Type Description
Execution.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Execution.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Execution.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Execution.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Execution.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Execution.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Execution.Builder mergeUpdateTime(Timestamp value)

Output only. Time the Execution was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Execution.Builder

setCreateTime(Timestamp value)

public Execution.Builder setCreateTime(Timestamp value)

Output only. Time the Execution was instantiated.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Execution.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Execution.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time the Execution was instantiated.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Execution.Builder

setDescription(String value)

public Execution.Builder setDescription(String value)

A brief description of this execution.

string description = 4;

Parameter
Name Description
value String

The description to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Execution.Builder setDescriptionBytes(ByteString value)

A brief description of this execution.

string description = 4;

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setDisplayName(String value)

public Execution.Builder setDisplayName(String value)

Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Execution.Builder setDisplayNameBytes(ByteString value)

Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'.

string display_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setExecutionTemplate(ExecutionTemplate value)

public Execution.Builder setExecutionTemplate(ExecutionTemplate value)

execute metadata including name, hardware spec, region, labels, etc.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;

Parameter
Name Description
value ExecutionTemplate
Returns
Type Description
Execution.Builder

setExecutionTemplate(ExecutionTemplate.Builder builderForValue)

public Execution.Builder setExecutionTemplate(ExecutionTemplate.Builder builderForValue)

execute metadata including name, hardware spec, region, labels, etc.

.google.cloud.notebooks.v1.ExecutionTemplate execution_template = 1;

Parameter
Name Description
builderForValue ExecutionTemplate.Builder
Returns
Type Description
Execution.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Execution.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Execution.Builder
Overrides

setJobUri(String value)

public Execution.Builder setJobUri(String value)

Output only. The URI of the external job used to execute the notebook.

string job_uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The jobUri to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setJobUriBytes(ByteString value)

public Execution.Builder setJobUriBytes(ByteString value)

Output only. The URI of the external job used to execute the notebook.

string job_uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for jobUri to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setName(String value)

public Execution.Builder setName(String value)

Output only. The resource name of the execute. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Execution.Builder setNameBytes(ByteString value)

Output only. The resource name of the execute. Format: projects/{project_id}/locations/{location}/executions/{execution_id}

string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setOutputNotebookFile(String value)

public Execution.Builder setOutputNotebookFile(String value)

Output notebook file generated by this execution

string output_notebook_file = 8;

Parameter
Name Description
value String

The outputNotebookFile to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setOutputNotebookFileBytes(ByteString value)

public Execution.Builder setOutputNotebookFileBytes(ByteString value)

Output notebook file generated by this execution

string output_notebook_file = 8;

Parameter
Name Description
value ByteString

The bytes for outputNotebookFile to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

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

public Execution.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Execution.Builder
Overrides

setState(Execution.State value)

public Execution.Builder setState(Execution.State value)

Output only. State of the underlying AI Platform job.

.google.cloud.notebooks.v1.Execution.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Execution.State

The state to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setStateValue(int value)

public Execution.Builder setStateValue(int value)

Output only. State of the underlying AI Platform job.

.google.cloud.notebooks.v1.Execution.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Execution.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Execution.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Execution.Builder
Overrides

setUpdateTime(Timestamp value)

public Execution.Builder setUpdateTime(Timestamp value)

Output only. Time the Execution was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Execution.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Execution.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Time the Execution was last updated.

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Execution.Builder