google_api_dataflow v0.3.0 GoogleApi.Dataflow.V1b3.Api.Projects View Source
API calls for all endpoints tagged Projects.
Link to this section Summary
Functions
List the jobs of a project across all regions
Creates a Cloud Dataflow job
Get encoded debug configuration for component. Not cacheable
Send encoded debug capture data for component
Gets the state of the specified Cloud Dataflow job
Request the job status
List the jobs of a project in a given region
Request the job status
Snapshot the state of a streaming job
Updates the state of an existing Cloud Dataflow job
Leases a dataflow WorkItem to run
Reports the status of dataflow WorkItems leased by a worker
Creates a Cloud Dataflow job
Get encoded debug configuration for component. Not cacheable
Send encoded debug capture data for component
Gets the state of the specified Cloud Dataflow job
Request the job status
List the jobs of a project in a given region
Request the job status
Snapshot the state of a streaming job
Updates the state of an existing Cloud Dataflow job
Leases a dataflow WorkItem to run
Reports the status of dataflow WorkItems leased by a worker
Creates a Cloud Dataflow job from a template
Get the template associated with a template
Launch a template
Send a worker_message to the service
Creates a Cloud Dataflow job from a template
Get the template associated with a template
Launch a template
Send a worker_message to the service
Link to this section Functions
Link to this function
dataflow_projects_jobs_aggregated(connection, project_id, optional_params \\ [], opts \\ []) View Source
List the jobs of a project across all regions.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project which owns the jobs.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :filter (String.t): The kind of filter to use.
- :location (String.t): The location that contains this job.
- :pageSize (integer()): If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.
- :pageToken (String.t): Set this to the 'next_page_token' field of a previous response to request additional results in a long list.
- :view (String.t): Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.ListJobsResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_create(connection, project_id, optional_params \\ [], opts \\ []) View Source
Creates a Cloud Dataflow job.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The ID of the Cloud Platform project that the job belongs to.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :location (String.t): The location that contains this job.
- :replaceJobId (String.t): Deprecated. This field is now in the Job message.
- :view (String.t): The level of information requested in response.
- :body (Job):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Job{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_debug_get_config(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Get encoded debug configuration for component. Not cacheable.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project id.
- job_id (String.t): The job id.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (GetDebugConfigRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.GetDebugConfigResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_debug_send_capture(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Send encoded debug capture data for component.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project id.
- job_id (String.t): The job id.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (SendDebugCaptureRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.SendDebugCaptureResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_get(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Gets the state of the specified Cloud Dataflow job.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The ID of the Cloud Platform project that the job belongs to.
- job_id (String.t): The job ID.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :location (String.t): The location that contains this job.
- :view (String.t): The level of information requested in response.
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Job{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_get_metrics(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Request the job status.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): A project id.
- job_id (String.t): The job to get messages for.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :location (String.t): The location which contains the job specified by job_id.
- :startTime (DateTime.t): Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.JobMetrics{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_list(connection, project_id, optional_params \\ [], opts \\ []) View Source
List the jobs of a project in a given region.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project which owns the jobs.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :filter (String.t): The kind of filter to use.
- :location (String.t): The location that contains this job.
- :pageSize (integer()): If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.
- :pageToken (String.t): Set this to the 'next_page_token' field of a previous response to request additional results in a long list.
- :view (String.t): Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.ListJobsResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_messages_list(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Request the job status.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): A project id.
- job_id (String.t): The job to get messages about.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :endTime (DateTime.t): Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).
- :location (String.t): The location which contains the job specified by job_id.
- :minimumImportance (String.t): Filter to only get messages with importance >= level
- :pageSize (integer()): If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.
- :pageToken (String.t): If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.
- :startTime (DateTime.t): If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.ListJobMessagesResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_snapshot(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Snapshot the state of a streaming job.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project which owns the job to be snapshotted.
- job_id (String.t): The job to be snapshotted.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (SnapshotJobRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Snapshot{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_update(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Updates the state of an existing Cloud Dataflow job.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The ID of the Cloud Platform project that the job belongs to.
- job_id (String.t): The job ID.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :location (String.t): The location that contains this job.
- :body (Job):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Job{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_work_items_lease(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Leases a dataflow WorkItem to run.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): Identifies the project this worker belongs to.
- job_id (String.t): Identifies the workflow job this worker belongs to.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (LeaseWorkItemRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.LeaseWorkItemResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_jobs_work_items_report_status(connection, project_id, job_id, optional_params \\ [], opts \\ []) View Source
Reports the status of dataflow WorkItems leased by a worker.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project which owns the WorkItem's job.
- job_id (String.t): The job which the WorkItem is part of.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (ReportWorkItemStatusRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.ReportWorkItemStatusResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_create(connection, project_id, location, optional_params \\ [], opts \\ []) View Source
Creates a Cloud Dataflow job.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The ID of the Cloud Platform project that the job belongs to.
- location (String.t): The location that contains this job.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :replaceJobId (String.t): Deprecated. This field is now in the Job message.
- :view (String.t): The level of information requested in response.
- :body (Job):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Job{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_debug_get_config(connection, project_id, location, job_id, optional_params \\ [], opts \\ []) View Source
Get encoded debug configuration for component. Not cacheable.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project id.
- location (String.t): The location which contains the job specified by job_id.
- job_id (String.t): The job id.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (GetDebugConfigRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.GetDebugConfigResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_debug_send_capture(connection, project_id, location, job_id, optional_params \\ [], opts \\ []) View Source
Send encoded debug capture data for component.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project id.
- location (String.t): The location which contains the job specified by job_id.
- job_id (String.t): The job id.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (SendDebugCaptureRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.SendDebugCaptureResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_get(connection, project_id, location, job_id, optional_params \\ [], opts \\ []) View Source
Gets the state of the specified Cloud Dataflow job.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The ID of the Cloud Platform project that the job belongs to.
- location (String.t): The location that contains this job.
- job_id (String.t): The job ID.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :view (String.t): The level of information requested in response.
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Job{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_get_metrics(connection, project_id, location, job_id, optional_params \\ [], opts \\ []) View Source
Request the job status.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): A project id.
- location (String.t): The location which contains the job specified by job_id.
- job_id (String.t): The job to get messages for.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :startTime (DateTime.t): Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.JobMetrics{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_list(connection, project_id, location, optional_params \\ [], opts \\ []) View Source
List the jobs of a project in a given region.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project which owns the jobs.
- location (String.t): The location that contains this job.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :filter (String.t): The kind of filter to use.
- :pageSize (integer()): If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.
- :pageToken (String.t): Set this to the 'next_page_token' field of a previous response to request additional results in a long list.
- :view (String.t): Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.ListJobsResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_messages_list(connection, project_id, location, job_id, optional_params \\ [], opts \\ []) View Source
Request the job status.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): A project id.
- location (String.t): The location which contains the job specified by job_id.
- job_id (String.t): The job to get messages about.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :endTime (DateTime.t): Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).
- :minimumImportance (String.t): Filter to only get messages with importance >= level
- :pageSize (integer()): If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.
- :pageToken (String.t): If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.
- :startTime (DateTime.t): If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.ListJobMessagesResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_snapshot(connection, project_id, location, job_id, optional_params \\ [], opts \\ []) View Source
Snapshot the state of a streaming job.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project which owns the job to be snapshotted.
- location (String.t): The location that contains this job.
- job_id (String.t): The job to be snapshotted.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (SnapshotJobRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Snapshot{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_update(connection, project_id, location, job_id, optional_params \\ [], opts \\ []) View Source
Updates the state of an existing Cloud Dataflow job.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The ID of the Cloud Platform project that the job belongs to.
- location (String.t): The location that contains this job.
- job_id (String.t): The job ID.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (Job):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Job{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_work_items_lease(connection, project_id, location, job_id, optional_params \\ [], opts \\ []) View Source
Leases a dataflow WorkItem to run.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): Identifies the project this worker belongs to.
- location (String.t): The location which contains the WorkItem's job.
- job_id (String.t): Identifies the workflow job this worker belongs to.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (LeaseWorkItemRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.LeaseWorkItemResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_jobs_work_items_report_status(connection, project_id, location, job_id, optional_params \\ [], opts \\ []) View Source
Reports the status of dataflow WorkItems leased by a worker.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project which owns the WorkItem's job.
- location (String.t): The location which contains the WorkItem's job.
- job_id (String.t): The job which the WorkItem is part of.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (ReportWorkItemStatusRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.ReportWorkItemStatusResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_templates_create(connection, project_id, location, optional_params \\ [], opts \\ []) View Source
Creates a Cloud Dataflow job from a template.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): Required. The ID of the Cloud Platform project that the job belongs to.
- location (String.t): The location to which to direct the request.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (CreateJobFromTemplateRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Job{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_templates_get(connection, project_id, location, optional_params \\ [], opts \\ []) View Source
Get the template associated with a template.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): Required. The ID of the Cloud Platform project that the job belongs to.
- location (String.t): The location to which to direct the request.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :gcsPath (String.t): Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
- :view (String.t): The view to retrieve. Defaults to METADATA_ONLY.
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.GetTemplateResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_templates_launch(connection, project_id, location, optional_params \\ [], opts \\ []) View Source
Launch a template.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): Required. The ID of the Cloud Platform project that the job belongs to.
- location (String.t): The location to which to direct the request.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :dynamicTemplate.gcsPath (String.t): Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object.
- :dynamicTemplate.stagingLocation (String.t): Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`.
- :gcsPath (String.t): A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
- :validateOnly (boolean()): If true, the request is validated but not actually executed. Defaults to false.
- :body (LaunchTemplateParameters):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.LaunchTemplateResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_locations_worker_messages(connection, project_id, location, optional_params \\ [], opts \\ []) View Source
Send a worker_message to the service.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project to send the WorkerMessages to.
- location (String.t): The location which contains the job
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (SendWorkerMessagesRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.SendWorkerMessagesResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_templates_create(connection, project_id, optional_params \\ [], opts \\ []) View Source
Creates a Cloud Dataflow job from a template.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): Required. The ID of the Cloud Platform project that the job belongs to.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (CreateJobFromTemplateRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.Job{}} on success {:error, info} on failure
Link to this function
dataflow_projects_templates_get(connection, project_id, optional_params \\ [], opts \\ []) View Source
Get the template associated with a template.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): Required. The ID of the Cloud Platform project that the job belongs to.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :gcsPath (String.t): Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
- :location (String.t): The location to which to direct the request.
- :view (String.t): The view to retrieve. Defaults to METADATA_ONLY.
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.GetTemplateResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_templates_launch(connection, project_id, optional_params \\ [], opts \\ []) View Source
Launch a template.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): Required. The ID of the Cloud Platform project that the job belongs to.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :dynamicTemplate.gcsPath (String.t): Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object.
- :dynamicTemplate.stagingLocation (String.t): Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`.
- :gcsPath (String.t): A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'.
- :location (String.t): The location to which to direct the request.
- :validateOnly (boolean()): If true, the request is validated but not actually executed. Defaults to false.
- :body (LaunchTemplateParameters):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.LaunchTemplateResponse{}} on success {:error, info} on failure
Link to this function
dataflow_projects_worker_messages(connection, project_id, optional_params \\ [], opts \\ []) View Source
Send a worker_message to the service.
Parameters
- connection (GoogleApi.Dataflow.V1b3.Connection): Connection to server
- project_id (String.t): The project to send the WorkerMessages to.
optional_params (KeywordList): [optional] Optional parameters
- :$.xgafv (String.t): V1 error format.
- :access_token (String.t): OAuth access token.
- :alt (String.t): Data format for response.
- :callback (String.t): JSONP
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): 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.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): 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.
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :body (SendWorkerMessagesRequest):
Returns
{:ok, %GoogleApi.Dataflow.V1b3.Model.SendWorkerMessagesResponse{}} on success {:error, info} on failure