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, update_mask: 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, update_mask: 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. Note: This method doesn't support filtering the list of jobs by name.
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 159 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.
1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1719 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.
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1519 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.
207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 207 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.
771 772 773 774 775 776 777 778 779 780 781 782 783 784 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 771 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.
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1410 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.
253 254 255 256 257 258 259 260 261 262 263 264 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 253 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.
482 483 484 485 486 487 488 489 490 491 492 493 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 482 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.
298 299 300 301 302 303 304 305 306 307 308 309 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 298 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.
817 818 819 820 821 822 823 824 825 826 827 828 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 817 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.
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1099 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.
863 864 865 866 867 868 869 870 871 872 873 874 875 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 863 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.
909 910 911 912 913 914 915 916 917 918 919 920 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 909 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.
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1289 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.
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1446 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.
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1560 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.
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1649 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.
1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1759 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.
726 727 728 729 730 731 732 733 734 735 736 737 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 726 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.
1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1608 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.
1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1807 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.
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1332 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.
615 616 617 618 619 620 621 622 623 624 625 626 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 615 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.
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 575 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, because you can only get the list of
jobs that are running in us-central1. projects.locations.jobs.list and
projects.jobs.list support filtering the list of jobs by name. Filtering by
name isn't supported by projects.jobs.aggregated.
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 355 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.
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1197 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.
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1238 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, because you can only get the list of
jobs that are running in us-central1. projects.locations.jobs.list and
projects.jobs.list support filtering the list of jobs by name. Filtering by
name isn't supported by projects.jobs.aggregated.
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 966 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.
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1482 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.
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1685 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.
651 652 653 654 655 656 657 658 659 660 661 662 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 651 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.
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1372 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.
518 519 520 521 522 523 524 525 526 527 528 529 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 518 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.
1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1139 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.
394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 394 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.
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1007 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, update_mask: 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.
444 445 446 447 448 449 450 451 452 453 454 455 456 457 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 444 def update_project_job(project_id, job_id, job_object = nil, location: nil, update_mask: 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['updateMask'] = update_mask unless update_mask.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, update_mask: 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.
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 1058 def update_project_location_job(project_id, location, job_id, job_object = nil, update_mask: 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['updateMask'] = update_mask unless update_mask.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.
688 689 690 691 692 693 694 695 696 697 698 699 |
# File 'lib/google/apis/dataflow_v1b3/service.rb', line 688 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 |