Class: Google::Cloud::Notebooks::V1::Execution

Inherits:

Object

• Object
• Google::Cloud::Notebooks::V1::Execution

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/notebooks/v1/execution.rb

Overview

The definition of a single executed notebook.

Defined Under Namespace

Modules: State

Instance Attribute Summary

• #create_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #description ⇒ ::String

  A brief description of this execution.

• #display_name ⇒ ::String readonly

  Output only.

• #execution_template ⇒ ::Google::Cloud::Notebooks::V1::ExecutionTemplate

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

• #job_uri ⇒ ::String readonly

  Output only.

• #name ⇒ ::String readonly

  Output only.

• #output_notebook_file ⇒ ::String

  Output notebook file generated by this execution.

• #state ⇒ ::Google::Cloud::Notebooks::V1::Execution::State readonly

  Output only.

• #update_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time the Execution was instantiated.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. Time the Execution was instantiated.

# File 'proto_docs/google/cloud/notebooks/v1/execution.rb', line 322

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum description of the state of the underlying AIP job.
  module State
    # The job state is unspecified.
    STATE_UNSPECIFIED = 0

    # The job has been just created and processing has not yet begun.
    QUEUED = 1

    # The service is preparing to execution the job.
    PREPARING = 2

    # The job is in progress.
    RUNNING = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job failed.
    # `error_message` should contain the details of the failure.
    FAILED = 5

    # The job is being cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLING = 6

    # The job has been cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLED = 7

    # The job has become expired (relevant to Vertex AI jobs)
    # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
    EXPIRED = 9

    # The Execution is being created.
    INITIALIZING = 10
  end
end

#description ⇒ ::String

Returns A brief description of this execution.

Returns:

• (::String) —

  A brief description of this execution.

# File 'proto_docs/google/cloud/notebooks/v1/execution.rb', line 322

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum description of the state of the underlying AIP job.
  module State
    # The job state is unspecified.
    STATE_UNSPECIFIED = 0

    # The job has been just created and processing has not yet begun.
    QUEUED = 1

    # The service is preparing to execution the job.
    PREPARING = 2

    # The job is in progress.
    RUNNING = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job failed.
    # `error_message` should contain the details of the failure.
    FAILED = 5

    # The job is being cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLING = 6

    # The job has been cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLED = 7

    # The job has become expired (relevant to Vertex AI jobs)
    # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
    EXPIRED = 9

    # The Execution is being created.
    INITIALIZING = 10
  end
end

#display_name ⇒ ::String (readonly)

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/notebooks/v1/execution.rb', line 322

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum description of the state of the underlying AIP job.
  module State
    # The job state is unspecified.
    STATE_UNSPECIFIED = 0

    # The job has been just created and processing has not yet begun.
    QUEUED = 1

    # The service is preparing to execution the job.
    PREPARING = 2

    # The job is in progress.
    RUNNING = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job failed.
    # `error_message` should contain the details of the failure.
    FAILED = 5

    # The job is being cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLING = 6

    # The job has been cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLED = 7

    # The job has become expired (relevant to Vertex AI jobs)
    # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
    EXPIRED = 9

    # The Execution is being created.
    INITIALIZING = 10
  end
end

#execution_template ⇒ ::Google::Cloud::Notebooks::V1::ExecutionTemplate

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

Returns:

• (::Google::Cloud::Notebooks::V1::ExecutionTemplate) —

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

# File 'proto_docs/google/cloud/notebooks/v1/execution.rb', line 322

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum description of the state of the underlying AIP job.
  module State
    # The job state is unspecified.
    STATE_UNSPECIFIED = 0

    # The job has been just created and processing has not yet begun.
    QUEUED = 1

    # The service is preparing to execution the job.
    PREPARING = 2

    # The job is in progress.
    RUNNING = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job failed.
    # `error_message` should contain the details of the failure.
    FAILED = 5

    # The job is being cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLING = 6

    # The job has been cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLED = 7

    # The job has become expired (relevant to Vertex AI jobs)
    # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
    EXPIRED = 9

    # The Execution is being created.
    INITIALIZING = 10
  end
end

#job_uri ⇒ ::String (readonly)

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/notebooks/v1/execution.rb', line 322

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum description of the state of the underlying AIP job.
  module State
    # The job state is unspecified.
    STATE_UNSPECIFIED = 0

    # The job has been just created and processing has not yet begun.
    QUEUED = 1

    # The service is preparing to execution the job.
    PREPARING = 2

    # The job is in progress.
    RUNNING = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job failed.
    # `error_message` should contain the details of the failure.
    FAILED = 5

    # The job is being cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLING = 6

    # The job has been cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLED = 7

    # The job has become expired (relevant to Vertex AI jobs)
    # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
    EXPIRED = 9

    # The Execution is being created.
    INITIALIZING = 10
  end
end

#name ⇒ ::String (readonly)

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

Returns:

• (::String) —

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

# File 'proto_docs/google/cloud/notebooks/v1/execution.rb', line 322

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum description of the state of the underlying AIP job.
  module State
    # The job state is unspecified.
    STATE_UNSPECIFIED = 0

    # The job has been just created and processing has not yet begun.
    QUEUED = 1

    # The service is preparing to execution the job.
    PREPARING = 2

    # The job is in progress.
    RUNNING = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job failed.
    # `error_message` should contain the details of the failure.
    FAILED = 5

    # The job is being cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLING = 6

    # The job has been cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLED = 7

    # The job has become expired (relevant to Vertex AI jobs)
    # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
    EXPIRED = 9

    # The Execution is being created.
    INITIALIZING = 10
  end
end

#output_notebook_file ⇒ ::String

Returns Output notebook file generated by this execution.

Returns:

• (::String) —

  Output notebook file generated by this execution

# File 'proto_docs/google/cloud/notebooks/v1/execution.rb', line 322

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum description of the state of the underlying AIP job.
  module State
    # The job state is unspecified.
    STATE_UNSPECIFIED = 0

    # The job has been just created and processing has not yet begun.
    QUEUED = 1

    # The service is preparing to execution the job.
    PREPARING = 2

    # The job is in progress.
    RUNNING = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job failed.
    # `error_message` should contain the details of the failure.
    FAILED = 5

    # The job is being cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLING = 6

    # The job has been cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLED = 7

    # The job has become expired (relevant to Vertex AI jobs)
    # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
    EXPIRED = 9

    # The Execution is being created.
    INITIALIZING = 10
  end
end

#state ⇒ ::Google::Cloud::Notebooks::V1::Execution::State (readonly)

Returns Output only. State of the underlying AI Platform job.

Returns:

• (::Google::Cloud::Notebooks::V1::Execution::State) —

  Output only. State of the underlying AI Platform job.

# File 'proto_docs/google/cloud/notebooks/v1/execution.rb', line 322

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum description of the state of the underlying AIP job.
  module State
    # The job state is unspecified.
    STATE_UNSPECIFIED = 0

    # The job has been just created and processing has not yet begun.
    QUEUED = 1

    # The service is preparing to execution the job.
    PREPARING = 2

    # The job is in progress.
    RUNNING = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job failed.
    # `error_message` should contain the details of the failure.
    FAILED = 5

    # The job is being cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLING = 6

    # The job has been cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLED = 7

    # The job has become expired (relevant to Vertex AI jobs)
    # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
    EXPIRED = 9

    # The Execution is being created.
    INITIALIZING = 10
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time the Execution was last updated.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. Time the Execution was last updated.

# File 'proto_docs/google/cloud/notebooks/v1/execution.rb', line 322

class Execution
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum description of the state of the underlying AIP job.
  module State
    # The job state is unspecified.
    STATE_UNSPECIFIED = 0

    # The job has been just created and processing has not yet begun.
    QUEUED = 1

    # The service is preparing to execution the job.
    PREPARING = 2

    # The job is in progress.
    RUNNING = 3

    # The job completed successfully.
    SUCCEEDED = 4

    # The job failed.
    # `error_message` should contain the details of the failure.
    FAILED = 5

    # The job is being cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLING = 6

    # The job has been cancelled.
    # `error_message` should describe the reason for the cancellation.
    CANCELLED = 7

    # The job has become expired (relevant to Vertex AI jobs)
    # https://cloud.google.com/vertex-ai/docs/reference/rest/v1/JobState
    EXPIRED = 9

    # The Execution is being created.
    INITIALIZING = 10
  end
end