Console
    Contact Us Start free

    Batch V1 API - Class Google::Cloud::Batch::V1::Job (v0.20.1)

    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

    #allocation_policy=

      def 
  
 allocation_policy= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Cloud 
 :: 
 Batch 
 :: 
 V1 
 :: 
 AllocationPolicy
    Parameter
    Returns

    #create_time

      def 
  
 create_time 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Protobuf 
 :: 
 Timestamp
    Returns

    #labels

      def 
  
 labels 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Protobuf 
 :: 
 Map 
 { 
 :: 
 String 
  
 = 
>  
 :: 
 String 
 }
    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 .

    #labels=

      def 
  
 labels= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Protobuf 
 :: 
 Map 
 { 
 :: 
 String 
  
 = 
>  
 :: 
 String 
 }
    Parameter
    • value(::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 .

    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 .

    #logs_policy

      def 
  
 logs_policy 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Cloud 
 :: 
 Batch 
 :: 
 V1 
 :: 
 LogsPolicy
    Returns

    #logs_policy=

      def 
  
 logs_policy= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Google 
 :: 
 Cloud 
 :: 
 Batch 
 :: 
 V1 
 :: 
 LogsPolicy
    Parameter
    Returns

    #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

    #notifications=

      def 
  
 notifications= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Array 
< :: 
 Google 
 :: 
 Cloud 
 :: 
 Batch 
 :: 
 V1 
 :: 
 JobNotification 
>
    Parameter
    Returns

    #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

    #task_groups

      def 
  
 task_groups 
 () 
  
 - 
>  
 :: 
 Array 
< :: 
 Google 
 :: 
 Cloud 
 :: 
 Batch 
 :: 
 V1 
 :: 
 TaskGroup 
>
    Returns

    #task_groups=

      def 
  
 task_groups= 
 ( 
 value 
 ) 
  
 - 
>  
 :: 
 Array 
< :: 
 Google 
 :: 
 Cloud 
 :: 
 Batch 
 :: 
 V1 
 :: 
 TaskGroup 
>
    Parameter
    Returns

    #uid

      def 
  
 uid 
 () 
  
 - 
>  
 :: 
 String
    Returns
    • (::String) — Output only. A system generated unique ID for the Job.

    #update_time

      def 
  
 update_time 
 () 
  
 - 
>  
 :: 
 Google 
 :: 
 Protobuf 
 :: 
 Timestamp
    Returns
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: