Class: Google::Cloud::Batch::V1::Job

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/batch/v1/job.rb

Overview

The Cloud Batch Job description.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#allocation_policy ⇒ ::Google::Cloud::Batch::V1::AllocationPolicy

Returns Compute resource allocation for all TaskGroups in the Job.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Output only. When the Job was created.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Custom labels to apply to the job and any Cloud Logging LogEntry that it generates.

Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple labels fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see Organize resources using labels.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Custom labels to apply to the job and any Cloud Logging LogEntry that it generates.

    Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple labels fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see Organize resources using labels.



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#logs_policy ⇒ ::Google::Cloud::Batch::V1::LogsPolicy

Returns Log preservation policy for the Job.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".

Returns:

  • (::String) —

    Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#notifications ⇒ ::Array<::Google::Cloud::Batch::V1::JobNotification>

Returns Notification configurations.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#priority ⇒ ::Integer

Returns Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.

Returns:

  • (::Integer) —

    Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied.



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#status ⇒ ::Google::Cloud::Batch::V1::JobStatus (readonly)

Returns Output only. Job status. It is read only for users.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#task_groups ⇒ ::Array<::Google::Cloud::Batch::V1::TaskGroup>

Returns Required. TaskGroups in the Job. Only one TaskGroup is supported now.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. A system generated unique ID for the Job.

Returns:

  • (::String) —

    Output only. A system generated unique ID for the Job.



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns Output only. The last time the Job was updated.

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'proto_docs/google/cloud/batch/v1/job.rb', line 74

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end