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:



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

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:



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

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 Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.

Returns:

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

    Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. Google Compute Engine label restrictions apply. Label names that start with "goog-" or "google-" are reserved.



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

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:



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

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".



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

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:



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

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.



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

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:



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

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:



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

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 (in UUID4 format) for the Job.

Returns:

  • (::String) —

    Output only. A system generated unique ID (in UUID4 format) for the Job.



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

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:



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

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