Class Execution (1.42.0)

public final class Execution extends GeneratedMessageV3 implements ExecutionOrBuilder

The definition of a single executed notebook.

Protobuf type google.cloud.notebooks.v1.Execution

Implements

ExecutionOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXECUTION_TEMPLATE_FIELD_NUMBER

public static final int EXECUTION_TEMPLATE_FIELD_NUMBER
Field Value
Type Description
int

JOB_URI_FIELD_NUMBER

public static final int JOB_URI_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_NOTEBOOK_FILE_FIELD_NUMBER

public static final int OUTPUT_NOTEBOOK_FILE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Execution getDefaultInstance()
Returns
Type Description
Execution

getDescriptor()

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

newBuilder()

public static Execution.Builder newBuilder()
Returns
Type Description
Execution.Builder

newBuilder(Execution prototype)

public static Execution.Builder newBuilder(Execution prototype)
Parameter
Name Description
prototype Execution
Returns
Type Description
Execution.Builder

parseDelimitedFrom(InputStream input)

public static Execution parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Execution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Execution parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Execution parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Execution parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Execution parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Execution parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Execution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Execution
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Execution> parser()
Returns
Type Description
Parser<Execution>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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.

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.

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.

getParserForType()

public Parser<Execution> getParserForType()
Returns
Type Description
Parser<Execution>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Execution.Builder newBuilderForType()
Returns
Type Description
Execution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Execution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Execution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Execution.Builder toBuilder()
Returns
Type Description
Execution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException