Class: Google::Apis::DataflowV1b3::Job

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dataflow_v1b3/classes.rb,
lib/google/apis/dataflow_v1b3/representations.rb,
lib/google/apis/dataflow_v1b3/representations.rb

Overview

Defines a job to be run by the Cloud Dataflow service. Do not enter confidential information when you supply string values using the API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Job

Returns a new instance of Job.



2254
2255
2256
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2254

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#client_request_id ⇒ String

The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it. Corresponds to the JSON property clientRequestId

Returns:

  • (String) 


2084
2085
2086
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2084

def client_request_id
  @client_request_id
end

#create_time ⇒ String

The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. Corresponds to the JSON property createTime

Returns:

  • (String) 


2090
2091
2092
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2090

def create_time
  @create_time
end

#created_from_snapshot_id ⇒ String

If this is specified, the job's initial state is populated from the given snapshot. Corresponds to the JSON property createdFromSnapshotId

Returns:

  • (String) 


2096
2097
2098
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2096

def created_from_snapshot_id
  @created_from_snapshot_id
end

#current_state ⇒ String

The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. Corresponds to the JSON property currentState

Returns:

  • (String) 


2105
2106
2107
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2105

def current_state
  @current_state
end

#current_state_time ⇒ String

The timestamp associated with the current state. Corresponds to the JSON property currentStateTime

Returns:

  • (String) 


2110
2111
2112
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2110

def current_state_time
  @current_state_time
end

#environment ⇒ Google::Apis::DataflowV1b3::Environment

Describes the environment in which a Dataflow Job runs. Corresponds to the JSON property environment

Returns:



2115
2116
2117
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2115

def environment
  @environment
end

#execution_info ⇒ Google::Apis::DataflowV1b3::JobExecutionInfo

Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. Corresponds to the JSON property executionInfo

Returns:



2121
2122
2123
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2121

def execution_info
  @execution_info
end

#id ⇒ String

The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job. Corresponds to the JSON property id

Returns:

  • (String) 


2127
2128
2129
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2127

def id
  @id
end

#job_metadata ⇒ Google::Apis::DataflowV1b3::JobMetadata

Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. Corresponds to the JSON property jobMetadata

Returns:



2133
2134
2135
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2133

def job_metadata
  @job_metadata
end

#labels ⇒ Hash<String,String>

User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \pLl\pLo0,62 * Values must conform to regexp: [\pLl\pLo\pN_-]0,63 * Both keys and values are additionally constrained to be <= 128 bytes in size. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2142
2143
2144
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2142

def labels
  @labels
end

#location ⇒ String

The regional endpoint that contains this job. Corresponds to the JSON property location

Returns:

  • (String) 


2148
2149
2150
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2148

def location
  @location
end

#name ⇒ String

The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression [a-z]([-a-z0-9]0,1022[a-z0-9])? Corresponds to the JSON property name

Returns:

  • (String) 


2157
2158
2159
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2157

def name
  @name
end

#pipeline_description ⇒ Google::Apis::DataflowV1b3::PipelineDescription

A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. Corresponds to the JSON property pipelineDescription

Returns:



2164
2165
2166
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2164

def pipeline_description
  @pipeline_description
end

#project_id ⇒ String

The ID of the Cloud Platform project that the job belongs to. Corresponds to the JSON property projectId

Returns:

  • (String) 


2169
2170
2171
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2169

def project_id
  @project_id
end

#replace_job_id ⇒ String

If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. Corresponds to the JSON property replaceJobId

Returns:

  • (String) 


2177
2178
2179
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2177

def replace_job_id
  @replace_job_id
end

#replaced_by_job_id ⇒ String

If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field contains the ID of that job. Corresponds to the JSON property replacedByJobId

Returns:

  • (String) 


2183
2184
2185
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2183

def replaced_by_job_id
  @replaced_by_job_id
end

#requested_state ⇒ String

The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state. Corresponds to the JSON property requestedState

Returns:

  • (String) 


2192
2193
2194
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2192

def requested_state
  @requested_state
end

#runtime_updatable_params ⇒ Google::Apis::DataflowV1b3::RuntimeUpdatableParams

Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. Corresponds to the JSON property runtimeUpdatableParams

Returns:



2199
2200
2201
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2199

def runtime_updatable_params
  @runtime_updatable_params
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


2205
2206
2207
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2205

def satisfies_pzs
  @satisfies_pzs
end

#stage_states ⇒ Array<Google::Apis::DataflowV1b3::ExecutionStageState>

This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. Corresponds to the JSON property stageStates

Returns:



2212
2213
2214
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2212

def stage_states
  @stage_states
end

#start_time ⇒ String

The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service. Corresponds to the JSON property startTime

Returns:

  • (String) 


2221
2222
2223
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2221

def start_time
  @start_time
end

#steps ⇒ Array<Google::Apis::DataflowV1b3::Step>

Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL. Corresponds to the JSON property steps

Returns:



2227
2228
2229
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2227

def steps
  @steps
end

#steps_location ⇒ String

The Cloud Storage location where the steps are stored. Corresponds to the JSON property stepsLocation

Returns:

  • (String) 


2232
2233
2234
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2232

def steps_location
  @steps_location
end

#temp_files ⇒ Array<String>

A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/bucket/object bucket. storage.googleapis.com/object Corresponds to the JSON property tempFiles

Returns:

  • (Array<String>) 


2241
2242
2243
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2241

def temp_files
  @temp_files
end

#transform_name_mapping ⇒ Hash<String,String>

The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. Corresponds to the JSON property transformNameMapping

Returns:

  • (Hash<String,String>) 


2247
2248
2249
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2247

def transform_name_mapping
  @transform_name_mapping
end

#type ⇒ String

The type of Cloud Dataflow job. Corresponds to the JSON property type

Returns:

  • (String) 


2252
2253
2254
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2252

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
 
# File 'lib/google/apis/dataflow_v1b3/classes.rb', line 2259

def update!(**args)
  @client_request_id = args[:client_request_id] if args.key?(:client_request_id)
  @create_time = args[:create_time] if args.key?(:create_time)
  @created_from_snapshot_id = args[:created_from_snapshot_id] if args.key?(:created_from_snapshot_id)
  @current_state = args[:current_state] if args.key?(:current_state)
  @current_state_time = args[:current_state_time] if args.key?(:current_state_time)
  @environment = args[:environment] if args.key?(:environment)
  @execution_info = args[:execution_info] if args.key?(:execution_info)
  @id = args[:id] if args.key?(:id)
  @job_metadata = args[:job_metadata] if args.key?(:job_metadata)
  @labels = args[:labels] if args.key?(:labels)
  @location = args[:location] if args.key?(:location)
  @name = args[:name] if args.key?(:name)
  @pipeline_description = args[:pipeline_description] if args.key?(:pipeline_description)
  @project_id = args[:project_id] if args.key?(:project_id)
  @replace_job_id = args[:replace_job_id] if args.key?(:replace_job_id)
  @replaced_by_job_id = args[:replaced_by_job_id] if args.key?(:replaced_by_job_id)
  @requested_state = args[:requested_state] if args.key?(:requested_state)
  @runtime_updatable_params = args[:runtime_updatable_params] if args.key?(:runtime_updatable_params)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @stage_states = args[:stage_states] if args.key?(:stage_states)
  @start_time = args[:start_time] if args.key?(:start_time)
  @steps = args[:steps] if args.key?(:steps)
  @steps_location = args[:steps_location] if args.key?(:steps_location)
  @temp_files = args[:temp_files] if args.key?(:temp_files)
  @transform_name_mapping = args[:transform_name_mapping] if args.key?(:transform_name_mapping)
  @type = args[:type] if args.key?(:type)
end