Reference documentation and code samples for the Batch V1 API class Google::Cloud::Batch::V1::Job.
The Cloud Batch Job description.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#allocation_policy
def
allocation_policy
()
-
>
::
Google
::
Cloud
::
Batch
::
V1
::
AllocationPolicy
Returns
- ( ::Google::Cloud::Batch::V1::AllocationPolicy ) — Compute resource allocation for all TaskGroups in the Job.
#allocation_policy=
def
allocation_policy=
(
value
)
-
>
::
Google
::
Cloud
::
Batch
::
V1
::
AllocationPolicy
Parameter
- value( ::Google::Cloud::Batch::V1::AllocationPolicy ) — Compute resource allocation for all TaskGroups in the Job.
Returns
- ( ::Google::Cloud::Batch::V1::AllocationPolicy ) — Compute resource allocation for all TaskGroups in the Job.
#create_time
def
create_time
()
-
>
::
Google
::
Protobuf
::
Timestamp
Returns
- ( ::Google::Protobuf::Timestamp ) — Output only. When the Job was created.
#labels
def
labels
()
-
>
::
Google
::
Protobuf
::
Map
{
::
String
=
>
::
String
}
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.
#labels=
def
labels=
(
value
)
-
>
::
Google
::
Protobuf
::
Map
{
::
String
=
>
::
String
}
Parameter
- value(::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.
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.
#logs_policy
def
logs_policy
()
-
>
::
Google
::
Cloud
::
Batch
::
V1
::
LogsPolicy
Returns
- ( ::Google::Cloud::Batch::V1::LogsPolicy ) — Log preservation policy for the Job.
#logs_policy=
def
logs_policy=
(
value
)
-
>
::
Google
::
Cloud
::
Batch
::
V1
::
LogsPolicy
Parameter
- value( ::Google::Cloud::Batch::V1::LogsPolicy ) — Log preservation policy for the Job.
Returns
- ( ::Google::Cloud::Batch::V1::LogsPolicy ) — Log preservation policy for the Job.
#name
def
name
()
-
>
::
String
Returns
- (::String) — Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01".
#notifications
def
notifications
()
-
>
::
Array
< ::
Google
::
Cloud
::
Batch
::
V1
::
JobNotification
>
Returns
- (::Array< ::Google::Cloud::Batch::V1::JobNotification >) — Notification configurations.
#notifications=
def
notifications=
(
value
)
-
>
::
Array
< ::
Google
::
Cloud
::
Batch
::
V1
::
JobNotification
>
Parameter
- value(::Array< ::Google::Cloud::Batch::V1::JobNotification >) — Notification configurations.
Returns
- (::Array< ::Google::Cloud::Batch::V1::JobNotification >) — Notification configurations.
#priority
def
priority
()
-
>
::
Integer
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.
#priority=
def
priority=
(
value
)
-
>
::
Integer
Parameter
- value(::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.
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.
#status
def
status
()
-
>
::
Google
::
Cloud
::
Batch
::
V1
::
JobStatus
Returns
- ( ::Google::Cloud::Batch::V1::JobStatus ) — Output only. Job status. It is read only for users.
#task_groups
def
task_groups
()
-
>
::
Array
< ::
Google
::
Cloud
::
Batch
::
V1
::
TaskGroup
>
Returns
- (::Array< ::Google::Cloud::Batch::V1::TaskGroup >) — Required. TaskGroups in the Job. Only one TaskGroup is supported now.
#task_groups=
def
task_groups=
(
value
)
-
>
::
Array
< ::
Google
::
Cloud
::
Batch
::
V1
::
TaskGroup
>
Parameter
- value(::Array< ::Google::Cloud::Batch::V1::TaskGroup >) — Required. TaskGroups in the Job. Only one TaskGroup is supported now.
Returns
- (::Array< ::Google::Cloud::Batch::V1::TaskGroup >) — Required. TaskGroups in the Job. Only one TaskGroup is supported now.
#uid
def
uid
()
-
>
::
String
Returns
- (::String) — Output only. A system generated unique ID (in UUID4 format) for the Job.
#update_time
def
update_time
()
-
>
::
Google
::
Protobuf
::
Timestamp
Returns
- ( ::Google::Protobuf::Timestamp ) — Output only. The last time the Job was updated.
