Class: Google::Apis::DataflowV1b3::DataflowService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::DataflowV1b3::DataflowService
- Defined in:
- lib/google/apis/dataflow_v1b3/service.rb
Overview
Dataflow API
Manages Google Cloud Dataflow projects on Google Cloud Platform.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#aggregated_project_job(project_id, filter: nil, location: nil, name: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobsResponse
List the jobs of a project across all regions.
-
#create_job_from_template(project_id, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Creates a Cloud Dataflow job from a template.
-
#create_job_from_template_with_location(project_id, location, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Creates a Cloud Dataflow job from a template.
-
#create_project_job(project_id, job_object = nil, location: nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Creates a Cloud Dataflow job.
-
#create_project_location_job(project_id, location, job_object = nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Creates a Cloud Dataflow job.
-
#delete_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::DeleteSnapshotResponse
Deletes a snapshot.
-
#delete_project_snapshots(project_id, location: nil, snapshot_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::DeleteSnapshotResponse
Deletes a snapshot.
-
#get_project_job(project_id, job_id, location: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Gets the state of the specified Cloud Dataflow job.
-
#get_project_job_debug_config(project_id, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetDebugConfigResponse
Get encoded debug configuration for component.
-
#get_project_job_metrics(project_id, job_id, location: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::JobMetrics
Request the job status.
-
#get_project_location_job(project_id, location, job_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Gets the state of the specified Cloud Dataflow job.
-
#get_project_location_job_debug_config(project_id, location, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetDebugConfigResponse
Get encoded debug configuration for component.
-
#get_project_location_job_execution_details(project_id, location, job_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::JobExecutionDetails
Request detailed information about the execution status of the job.
-
#get_project_location_job_metrics(project_id, location, job_id, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::JobMetrics
Request the job status.
-
#get_project_location_job_stage_execution_details(project_id, location, job_id, stage_id, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::StageExecutionDetails
Request detailed information about the execution status of a stage of the job.
-
#get_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot
Gets information about a snapshot.
-
#get_project_location_template(project_id, location, gcs_path: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetTemplateResponse
Get the template associated with a template.
-
#get_project_snapshot(project_id, snapshot_id, location: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot
Gets information about a snapshot.
-
#get_project_template(project_id, gcs_path: nil, location: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetTemplateResponse
Get the template associated with a template.
-
#initialize ⇒ DataflowService
constructor
A new instance of DataflowService.
-
#launch_flex_template(project_id, location, launch_flex_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse
Launch a job with a FlexTemplate.
-
#launch_project_location_template(project_id, location, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LaunchTemplateResponse
Launch a template.
-
#launch_project_template(project_id, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, location: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LaunchTemplateResponse
Launch a template.
-
#lease_project_location_work_item(project_id, location, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LeaseWorkItemResponse
Leases a dataflow WorkItem to run.
-
#lease_project_work_item(project_id, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LeaseWorkItemResponse
Leases a dataflow WorkItem to run.
-
#list_project_job_messages(project_id, job_id, end_time: nil, location: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobMessagesResponse
Request the job status.
-
#list_project_jobs(project_id, filter: nil, location: nil, name: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobsResponse
List the jobs of a project.
-
#list_project_location_job_messages(project_id, location, job_id, end_time: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobMessagesResponse
Request the job status.
-
#list_project_location_job_snapshots(project_id, location, job_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListSnapshotsResponse
Lists snapshots.
-
#list_project_location_jobs(project_id, location, filter: nil, name: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobsResponse
List the jobs of a project.
-
#list_project_location_snapshots(project_id, location, job_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListSnapshotsResponse
Lists snapshots.
-
#list_project_snapshots(project_id, job_id: nil, location: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListSnapshotsResponse
Lists snapshots.
-
#report_project_job_work_item_status(project_id, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
Reports the status of dataflow WorkItems leased by a worker.
-
#report_project_location_job_work_item_status(project_id, location, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
Reports the status of dataflow WorkItems leased by a worker.
-
#send_project_job_debug_capture(project_id, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendDebugCaptureResponse
Send encoded debug capture data for component.
-
#send_project_location_job_debug_capture(project_id, location, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendDebugCaptureResponse
Send encoded debug capture data for component.
-
#snapshot_project_job(project_id, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot
Snapshot the state of a streaming job.
-
#snapshot_project_location_job(project_id, location, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot
Snapshot the state of a streaming job.
-
#update_project_job(project_id, job_id, job_object = nil, location: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Updates the state of an existing Cloud Dataflow job.
-
#update_project_location_job(project_id, location, job_id, job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Updates the state of an existing Cloud Dataflow job.
-
#worker_project_location_messages(project_id, location, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
Send a worker_message to the service.
-
#worker_project_messages(project_id, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
Send a worker_message to the service.
Constructor Details
#initialize ⇒ DataflowService
Returns a new instance of DataflowService.
45 46 47 48 49 50 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 45 def initialize super('https://dataflow.googleapis.com/', '', client_name: 'google-apis-dataflow_v1b3', client_version: Google::Apis::DataflowV1b3::GEM_VERSION) @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#aggregated_project_job(project_id, filter: nil, location: nil, name: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobsResponse
List the jobs of a project across all regions.
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 158 def aggregated_project_job(project_id, filter: nil, location: nil, name: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs:aggregated', ) command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse command.params['projectId'] = project_id unless project_id.nil? command.query['filter'] = filter unless filter.nil? command.query['location'] = location unless location.nil? command.query['name'] = name unless name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_job_from_template(project_id, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.
1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1698 def create_job_from_template(project_id, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/templates', ) command.request_representation = Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest::Representation command.request_object = create_job_from_template_request_object command.response_representation = Google::Apis::DataflowV1b3::Job::Representation command.response_class = Google::Apis::DataflowV1b3::Job command.params['projectId'] = project_id unless project_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_job_from_template_with_location(project_id, location, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API.
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1498 def create_job_from_template_with_location(project_id, location, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/templates', ) command.request_representation = Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest::Representation command.request_object = create_job_from_template_request_object command.response_representation = Google::Apis::DataflowV1b3::Job::Representation command.response_class = Google::Apis::DataflowV1b3::Job command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_job(project_id, job_object = nil, location: nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Creates a Cloud Dataflow job. To create a job, we recommend using projects.
locations.jobs.create with a regional endpoint. Using projects.jobs.create is
not recommended, as your job will always start in us-central1. Do not enter
confidential information when you supply string values using the API.
206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 206 def create_project_job(project_id, job_object = nil, location: nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs', ) command.request_representation = Google::Apis::DataflowV1b3::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::DataflowV1b3::Job::Representation command.response_class = Google::Apis::DataflowV1b3::Job command.params['projectId'] = project_id unless project_id.nil? command.query['location'] = location unless location.nil? command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_project_location_job(project_id, location, job_object = nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Creates a Cloud Dataflow job. To create a job, we recommend using projects.
locations.jobs.create with a regional endpoint. Using projects.jobs.create is
not recommended, as your job will always start in us-central1. Do not enter
confidential information when you supply string values using the API.
760 761 762 763 764 765 766 767 768 769 770 771 772 773 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 760 def create_project_location_job(project_id, location, job_object = nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs', ) command.request_representation = Google::Apis::DataflowV1b3::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::DataflowV1b3::Job::Representation command.response_class = Google::Apis::DataflowV1b3::Job command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::DeleteSnapshotResponse
Deletes a snapshot.
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1389 def delete_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', ) command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['snapshotId'] = snapshot_id unless snapshot_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_snapshots(project_id, location: nil, snapshot_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::DeleteSnapshotResponse
Deletes a snapshot.
76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 76 def delete_project_snapshots(project_id, location: nil, snapshot_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1b3/projects/{projectId}/snapshots', ) command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse command.params['projectId'] = project_id unless project_id.nil? command.query['location'] = location unless location.nil? command.query['snapshotId'] = snapshot_id unless snapshot_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_job(project_id, job_id, location: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Gets the state of the specified Cloud Dataflow job. To get the state of a job,
we recommend using projects.locations.jobs.get with a regional endpoint. Using
projects.jobs.get is not recommended, as you can only get the state of jobs
that are running in us-central1.
252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 252 def get_project_job(project_id, job_id, location: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}', ) command.response_representation = Google::Apis::DataflowV1b3::Job::Representation command.response_class = Google::Apis::DataflowV1b3::Job command.params['projectId'] = project_id unless project_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['location'] = location unless location.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_job_debug_config(project_id, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetDebugConfigResponse
Get encoded debug configuration for component. Not cacheable.
471 472 473 474 475 476 477 478 479 480 481 482 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 471 def get_project_job_debug_config(project_id, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig', ) command.request_representation = Google::Apis::DataflowV1b3::GetDebugConfigRequest::Representation command.request_object = get_debug_config_request_object command.response_representation = Google::Apis::DataflowV1b3::GetDebugConfigResponse::Representation command.response_class = Google::Apis::DataflowV1b3::GetDebugConfigResponse command.params['projectId'] = project_id unless project_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_job_metrics(project_id, job_id, location: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::JobMetrics
Request the job status. To request the status of a job, we recommend using
projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.
getMetrics is not recommended, as you can only request the status of jobs
that are running in us-central1.
297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 297 def get_project_job_metrics(project_id, job_id, location: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}/metrics', ) command.response_representation = Google::Apis::DataflowV1b3::JobMetrics::Representation command.response_class = Google::Apis::DataflowV1b3::JobMetrics command.params['projectId'] = project_id unless project_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['location'] = location unless location.nil? command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_job(project_id, location, job_id, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Gets the state of the specified Cloud Dataflow job. To get the state of a job,
we recommend using projects.locations.jobs.get with a regional endpoint. Using
projects.jobs.get is not recommended, as you can only get the state of jobs
that are running in us-central1.
806 807 808 809 810 811 812 813 814 815 816 817 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 806 def get_project_location_job(project_id, location, job_id, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}', ) command.response_representation = Google::Apis::DataflowV1b3::Job::Representation command.response_class = Google::Apis::DataflowV1b3::Job command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_job_debug_config(project_id, location, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetDebugConfigResponse
Get encoded debug configuration for component. Not cacheable.
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1078 def get_project_location_job_debug_config(project_id, location, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig', ) command.request_representation = Google::Apis::DataflowV1b3::GetDebugConfigRequest::Representation command.request_object = get_debug_config_request_object command.response_representation = Google::Apis::DataflowV1b3::GetDebugConfigResponse::Representation command.response_class = Google::Apis::DataflowV1b3::GetDebugConfigResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_job_execution_details(project_id, location, job_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::JobExecutionDetails
Request detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice.
852 853 854 855 856 857 858 859 860 861 862 863 864 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 852 def get_project_location_job_execution_details(project_id, location, job_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails', ) command.response_representation = Google::Apis::DataflowV1b3::JobExecutionDetails::Representation command.response_class = Google::Apis::DataflowV1b3::JobExecutionDetails command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_job_metrics(project_id, location, job_id, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::JobMetrics
Request the job status. To request the status of a job, we recommend using
projects.locations.jobs.getMetrics with a regional endpoint. Using projects.jobs.
getMetrics is not recommended, as you can only request the status of jobs
that are running in us-central1.
898 899 900 901 902 903 904 905 906 907 908 909 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 898 def get_project_location_job_metrics(project_id, location, job_id, start_time: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics', ) command.response_representation = Google::Apis::DataflowV1b3::JobMetrics::Representation command.response_class = Google::Apis::DataflowV1b3::JobMetrics command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_job_stage_execution_details(project_id, location, job_id, stage_id, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::StageExecutionDetails
Request detailed information about the execution status of a stage of the job. EXPERIMENTAL. This API is subject to change or removal without notice.
1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1268 def get_project_location_job_stage_execution_details(project_id, location, job_id, stage_id, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/executionDetails', ) command.response_representation = Google::Apis::DataflowV1b3::StageExecutionDetails::Representation command.response_class = Google::Apis::DataflowV1b3::StageExecutionDetails command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.params['stageId'] = stage_id unless stage_id.nil? command.query['endTime'] = end_time unless end_time.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot
Gets information about a snapshot.
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1425 def get_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', ) command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation command.response_class = Google::Apis::DataflowV1b3::Snapshot command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['snapshotId'] = snapshot_id unless snapshot_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_template(project_id, location, gcs_path: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetTemplateResponse
Get the template associated with a template.
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1539 def get_project_location_template(project_id, location, gcs_path: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/templates:get', ) command.response_representation = Google::Apis::DataflowV1b3::GetTemplateResponse::Representation command.response_class = Google::Apis::DataflowV1b3::GetTemplateResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.query['gcsPath'] = gcs_path unless gcs_path.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_snapshot(project_id, snapshot_id, location: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot
Gets information about a snapshot.
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1628 def get_project_snapshot(project_id, snapshot_id, location: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots/{snapshotId}', ) command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation command.response_class = Google::Apis::DataflowV1b3::Snapshot command.params['projectId'] = project_id unless project_id.nil? command.params['snapshotId'] = snapshot_id unless snapshot_id.nil? command.query['location'] = location unless location.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_template(project_id, gcs_path: nil, location: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::GetTemplateResponse
Get the template associated with a template.
1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1738 def get_project_template(project_id, gcs_path: nil, location: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/templates:get', ) command.response_representation = Google::Apis::DataflowV1b3::GetTemplateResponse::Representation command.response_class = Google::Apis::DataflowV1b3::GetTemplateResponse command.params['projectId'] = project_id unless project_id.nil? command.query['gcsPath'] = gcs_path unless gcs_path.nil? command.query['location'] = location unless location.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#launch_flex_template(project_id, location, launch_flex_template_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse
Launch a job with a FlexTemplate.
715 716 717 718 719 720 721 722 723 724 725 726 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 715 def launch_flex_template(project_id, location, launch_flex_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/flexTemplates:launch', ) command.request_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest::Representation command.request_object = launch_flex_template_request_object command.response_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse::Representation command.response_class = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#launch_project_location_template(project_id, location, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LaunchTemplateResponse
Launch a template.
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1587 def launch_project_location_template(project_id, location, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/templates:launch', ) command.request_representation = Google::Apis::DataflowV1b3::LaunchTemplateParameters::Representation command.request_object = launch_template_parameters_object command.response_representation = Google::Apis::DataflowV1b3::LaunchTemplateResponse::Representation command.response_class = Google::Apis::DataflowV1b3::LaunchTemplateResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.query['dynamicTemplate.gcsPath'] = dynamic_template_gcs_path unless dynamic_template_gcs_path.nil? command.query['dynamicTemplate.stagingLocation'] = dynamic_template_staging_location unless dynamic_template_staging_location.nil? command.query['gcsPath'] = gcs_path unless gcs_path.nil? command.query['validateOnly'] = validate_only unless validate_only.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#launch_project_template(project_id, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, location: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LaunchTemplateResponse
Launch a template.
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1786 def launch_project_template(project_id, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, location: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/templates:launch', ) command.request_representation = Google::Apis::DataflowV1b3::LaunchTemplateParameters::Representation command.request_object = launch_template_parameters_object command.response_representation = Google::Apis::DataflowV1b3::LaunchTemplateResponse::Representation command.response_class = Google::Apis::DataflowV1b3::LaunchTemplateResponse command.params['projectId'] = project_id unless project_id.nil? command.query['dynamicTemplate.gcsPath'] = dynamic_template_gcs_path unless dynamic_template_gcs_path.nil? command.query['dynamicTemplate.stagingLocation'] = dynamic_template_staging_location unless dynamic_template_staging_location.nil? command.query['gcsPath'] = gcs_path unless gcs_path.nil? command.query['location'] = location unless location.nil? command.query['validateOnly'] = validate_only unless validate_only.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#lease_project_location_work_item(project_id, location, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LeaseWorkItemResponse
Leases a dataflow WorkItem to run.
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1311 def lease_project_location_work_item(project_id, location, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease', ) command.request_representation = Google::Apis::DataflowV1b3::LeaseWorkItemRequest::Representation command.request_object = lease_work_item_request_object command.response_representation = Google::Apis::DataflowV1b3::LeaseWorkItemResponse::Representation command.response_class = Google::Apis::DataflowV1b3::LeaseWorkItemResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#lease_project_work_item(project_id, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::LeaseWorkItemResponse
Leases a dataflow WorkItem to run.
604 605 606 607 608 609 610 611 612 613 614 615 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 604 def lease_project_work_item(project_id, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease', ) command.request_representation = Google::Apis::DataflowV1b3::LeaseWorkItemRequest::Representation command.request_object = lease_work_item_request_object command.response_representation = Google::Apis::DataflowV1b3::LeaseWorkItemResponse::Representation command.response_class = Google::Apis::DataflowV1b3::LeaseWorkItemResponse command.params['projectId'] = project_id unless project_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_job_messages(project_id, job_id, end_time: nil, location: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobMessagesResponse
Request the job status. To request the status of a job, we recommend using
projects.locations.jobs.messages.list with a regional endpoint. Using projects.
jobs.messages.list is not recommended, as you can only request the status of
jobs that are running in us-central1.
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 564 def (project_id, job_id, end_time: nil, location: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}/messages', ) command.response_representation = Google::Apis::DataflowV1b3::ListJobMessagesResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ListJobMessagesResponse command.params['projectId'] = project_id unless project_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['endTime'] = end_time unless end_time.nil? command.query['location'] = location unless location.nil? command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_jobs(project_id, filter: nil, location: nil, name: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobsResponse
List the jobs of a project. To list the jobs of a project in a region, we
recommend using projects.locations.jobs.list with a regional endpoint. To list
the all jobs across all regions, use projects.jobs.aggregated. Using
projects.jobs.list is not recommended, as you can only get the list of jobs
that are running in us-central1.
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 352 def list_project_jobs(project_id, filter: nil, location: nil, name: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs', ) command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse command.params['projectId'] = project_id unless project_id.nil? command.query['filter'] = filter unless filter.nil? command.query['location'] = location unless location.nil? command.query['name'] = name unless name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_job_messages(project_id, location, job_id, end_time: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobMessagesResponse
Request the job status. To request the status of a job, we recommend using
projects.locations.jobs.messages.list with a regional endpoint. Using projects.
jobs.messages.list is not recommended, as you can only request the status of
jobs that are running in us-central1.
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1176 def (project_id, location, job_id, end_time: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages', ) command.response_representation = Google::Apis::DataflowV1b3::ListJobMessagesResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ListJobMessagesResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['endTime'] = end_time unless end_time.nil? command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['startTime'] = start_time unless start_time.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_job_snapshots(project_id, location, job_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListSnapshotsResponse
Lists snapshots.
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1217 def list_project_location_job_snapshots(project_id, location, job_id, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots', ) command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_jobs(project_id, location, filter: nil, name: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListJobsResponse
List the jobs of a project. To list the jobs of a project in a region, we
recommend using projects.locations.jobs.list with a regional endpoint. To list
the all jobs across all regions, use projects.jobs.aggregated. Using
projects.jobs.list is not recommended, as you can only get the list of jobs
that are running in us-central1.
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 953 def list_project_location_jobs(project_id, location, filter: nil, name: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs', ) command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.query['filter'] = filter unless filter.nil? command.query['name'] = name unless name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['view'] = view unless view.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_snapshots(project_id, location, job_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListSnapshotsResponse
Lists snapshots.
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1461 def list_project_location_snapshots(project_id, location, job_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots', ) command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.query['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_snapshots(project_id, job_id: nil, location: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ListSnapshotsResponse
Lists snapshots.
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1664 def list_project_snapshots(project_id, job_id: nil, location: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots', ) command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse command.params['projectId'] = project_id unless project_id.nil? command.query['jobId'] = job_id unless job_id.nil? command.query['location'] = location unless location.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#report_project_job_work_item_status(project_id, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
Reports the status of dataflow WorkItems leased by a worker.
640 641 642 643 644 645 646 647 648 649 650 651 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 640 def report_project_job_work_item_status(project_id, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus', ) command.request_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest::Representation command.request_object = report_work_item_status_request_object command.response_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse command.params['projectId'] = project_id unless project_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#report_project_location_job_work_item_status(project_id, location, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
Reports the status of dataflow WorkItems leased by a worker.
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1351 def report_project_location_job_work_item_status(project_id, location, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus', ) command.request_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest::Representation command.request_object = report_work_item_status_request_object command.response_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse::Representation command.response_class = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#send_project_job_debug_capture(project_id, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendDebugCaptureResponse
Send encoded debug capture data for component.
507 508 509 510 511 512 513 514 515 516 517 518 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 507 def send_project_job_debug_capture(project_id, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture', ) command.request_representation = Google::Apis::DataflowV1b3::SendDebugCaptureRequest::Representation command.request_object = send_debug_capture_request_object command.response_representation = Google::Apis::DataflowV1b3::SendDebugCaptureResponse::Representation command.response_class = Google::Apis::DataflowV1b3::SendDebugCaptureResponse command.params['projectId'] = project_id unless project_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#send_project_location_job_debug_capture(project_id, location, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendDebugCaptureResponse
Send encoded debug capture data for component.
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1118 def send_project_location_job_debug_capture(project_id, location, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture', ) command.request_representation = Google::Apis::DataflowV1b3::SendDebugCaptureRequest::Representation command.request_object = send_debug_capture_request_object command.response_representation = Google::Apis::DataflowV1b3::SendDebugCaptureResponse::Representation command.response_class = Google::Apis::DataflowV1b3::SendDebugCaptureResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#snapshot_project_job(project_id, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot
Snapshot the state of a streaming job.
391 392 393 394 395 396 397 398 399 400 401 402 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 391 def snapshot_project_job(project_id, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}:snapshot', ) command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation command.request_object = snapshot_job_request_object command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation command.response_class = Google::Apis::DataflowV1b3::Snapshot command.params['projectId'] = project_id unless project_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#snapshot_project_location_job(project_id, location, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Snapshot
Snapshot the state of a streaming job.
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 994 def snapshot_project_location_job(project_id, location, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot', ) command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation command.request_object = snapshot_job_request_object command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation command.response_class = Google::Apis::DataflowV1b3::Snapshot command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_project_job(project_id, job_id, job_object = nil, location: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Updates the state of an existing Cloud Dataflow job. To update the state of an
existing job, we recommend using projects.locations.jobs.update with a
regional endpoint. Using projects.jobs.update is not recommended, as you can only
update the state of jobs that are running in us-central1.
434 435 436 437 438 439 440 441 442 443 444 445 446 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 434 def update_project_job(project_id, job_id, job_object = nil, location: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1b3/projects/{projectId}/jobs/{jobId}', ) command.request_representation = Google::Apis::DataflowV1b3::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::DataflowV1b3::Job::Representation command.response_class = Google::Apis::DataflowV1b3::Job command.params['projectId'] = project_id unless project_id.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['location'] = location unless location.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#update_project_location_job(project_id, location, job_id, job_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::Job
Updates the state of an existing Cloud Dataflow job. To update the state of an
existing job, we recommend using projects.locations.jobs.update with a
regional endpoint. Using projects.jobs.update is not recommended, as you can only
update the state of jobs that are running in us-central1.
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1038 def update_project_location_job(project_id, location, job_id, job_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:put, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}', ) command.request_representation = Google::Apis::DataflowV1b3::Job::Representation command.request_object = job_object command.response_representation = Google::Apis::DataflowV1b3::Job::Representation command.response_class = Google::Apis::DataflowV1b3::Job command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.params['jobId'] = job_id unless job_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#worker_project_location_messages(project_id, location, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
Send a worker_message to the service.
677 678 679 680 681 682 683 684 685 686 687 688 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 677 def (project_id, location, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/WorkerMessages', ) command.request_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesRequest::Representation command.request_object = command.response_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse::Representation command.response_class = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse command.params['projectId'] = project_id unless project_id.nil? command.params['location'] = location unless location.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#worker_project_messages(project_id, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
Send a worker_message to the service.
109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 109 def (project_id, = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1b3/projects/{projectId}/WorkerMessages', ) command.request_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesRequest::Representation command.request_object = command.response_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse::Representation command.response_class = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse command.params['projectId'] = project_id unless project_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |