google_api_dataproc

v0.6.0

google_api_dataproc v0.6.0 GoogleApi.Dataproc.V1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

dataproc_projects_locations_autoscaling_policies_get_iam_policy(connection, projects_id, locations_id, autoscaling_policies_id, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

dataproc_projects_locations_autoscaling_policies_set_iam_policy(connection, projects_id, locations_id, autoscaling_policies_id, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy.

dataproc_projects_locations_autoscaling_policies_test_iam_permissions(connection, projects_id, locations_id, autoscaling_policies_id, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

dataproc_projects_locations_workflow_templates_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

Creates new workflow template.

dataproc_projects_locations_workflow_templates_delete(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Deletes a workflow template. It does not cancel in-progress workflows.

dataproc_projects_locations_workflow_templates_get(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

dataproc_projects_locations_workflow_templates_get_iam_policy(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

dataproc_projects_locations_workflow_templates_instantiate(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

dataproc_projects_locations_workflow_templates_instantiate_inline(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

dataproc_projects_locations_workflow_templates_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ [])

Lists workflows that match the specified filter in the request.

dataproc_projects_locations_workflow_templates_set_iam_policy(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy.

dataproc_projects_locations_workflow_templates_test_iam_permissions(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

dataproc_projects_locations_workflow_templates_update(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

dataproc_projects_regions_autoscaling_policies_get_iam_policy(connection, projects_id, regions_id, autoscaling_policies_id, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

dataproc_projects_regions_autoscaling_policies_set_iam_policy(connection, projects_id, regions_id, autoscaling_policies_id, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy.

dataproc_projects_regions_autoscaling_policies_test_iam_permissions(connection, projects_id, regions_id, autoscaling_policies_id, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

dataproc_projects_regions_clusters_create(connection, project_id, region, optional_params \\ [], opts \\ [])

Creates a cluster in a project.

dataproc_projects_regions_clusters_delete(connection, project_id, region, cluster_name, optional_params \\ [], opts \\ [])

Deletes a cluster in a project.

dataproc_projects_regions_clusters_diagnose(connection, project_id, region, cluster_name, optional_params \\ [], opts \\ [])

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.

dataproc_projects_regions_clusters_get(connection, project_id, region, cluster_name, optional_params \\ [], opts \\ [])

Gets the resource representation for a cluster in a project.

dataproc_projects_regions_clusters_get_iam_policy(connection, projects_id, regions_id, clusters_id, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

dataproc_projects_regions_clusters_list(connection, project_id, region, optional_params \\ [], opts \\ [])

Lists all regions/{region}/clusters in a project.

dataproc_projects_regions_clusters_patch(connection, project_id, region, cluster_name, optional_params \\ [], opts \\ [])

Updates a cluster in a project.

dataproc_projects_regions_clusters_set_iam_policy(connection, projects_id, regions_id, clusters_id, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy.

dataproc_projects_regions_clusters_test_iam_permissions(connection, projects_id, regions_id, clusters_id, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

dataproc_projects_regions_jobs_cancel(connection, project_id, region, job_id, optional_params \\ [], opts \\ [])

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

dataproc_projects_regions_jobs_delete(connection, project_id, region, job_id, optional_params \\ [], opts \\ [])

Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

dataproc_projects_regions_jobs_get(connection, project_id, region, job_id, optional_params \\ [], opts \\ [])

Gets the resource representation for a job in a project.

dataproc_projects_regions_jobs_get_iam_policy(connection, projects_id, regions_id, jobs_id, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

dataproc_projects_regions_jobs_list(connection, project_id, region, optional_params \\ [], opts \\ [])

Lists regions/{region}/jobs in a project.

dataproc_projects_regions_jobs_patch(connection, project_id, region, job_id, optional_params \\ [], opts \\ [])

Updates a job in a project.

dataproc_projects_regions_jobs_set_iam_policy(connection, projects_id, regions_id, jobs_id, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy.

dataproc_projects_regions_jobs_submit(connection, project_id, region, optional_params \\ [], opts \\ [])

Submits a job to a cluster.

dataproc_projects_regions_jobs_test_iam_permissions(connection, projects_id, regions_id, jobs_id, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

dataproc_projects_regions_operations_cancel(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ [])

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

dataproc_projects_regions_operations_delete(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ [])

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

dataproc_projects_regions_operations_get(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ [])

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

dataproc_projects_regions_operations_get_iam_policy(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

dataproc_projects_regions_operations_list(connection, projects_id, regions_id, optional_params \\ [], opts \\ [])

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users//operations. To override the binding, API services can add a binding such as "/v1/{name=users/}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

dataproc_projects_regions_operations_set_iam_policy(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy.

dataproc_projects_regions_operations_test_iam_permissions(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

dataproc_projects_regions_workflow_templates_create(connection, projects_id, regions_id, optional_params \\ [], opts \\ [])

Creates new workflow template.

dataproc_projects_regions_workflow_templates_delete(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Deletes a workflow template. It does not cancel in-progress workflows.

dataproc_projects_regions_workflow_templates_get(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

dataproc_projects_regions_workflow_templates_get_iam_policy(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

dataproc_projects_regions_workflow_templates_instantiate(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

dataproc_projects_regions_workflow_templates_instantiate_inline(connection, projects_id, regions_id, optional_params \\ [], opts \\ [])

Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

dataproc_projects_regions_workflow_templates_list(connection, projects_id, regions_id, optional_params \\ [], opts \\ [])

Lists workflows that match the specified filter in the request.

dataproc_projects_regions_workflow_templates_set_iam_policy(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy.

dataproc_projects_regions_workflow_templates_test_iam_permissions(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

dataproc_projects_regions_workflow_templates_update(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ [])

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Link to this section Functions

Link to this function

dataproc_projects_locations_autoscaling_policies_get_iam_policy(connection, projects_id, locations_id, autoscaling_policies_id, optional_params \\ [], opts \\ []) View Source

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • autoscaling_policies_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (GetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_autoscaling_policies_set_iam_policy(connection, projects_id, locations_id, autoscaling_policies_id, optional_params \\ [], opts \\ []) View Source

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • autoscaling_policies_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (SetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_autoscaling_policies_test_iam_permissions(connection, projects_id, locations_id, autoscaling_policies_id, optional_params \\ [], opts \\ []) View Source

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • autoscaling_policies_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (TestIamPermissionsRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_create(connection, projects_id, locations_id, optional_params \\ [], opts \\ []) View Source

Creates new workflow template.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `parent`. Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
  • locations_id (String.t): Part of `parent`. See documentation of `projectsId`.

  • 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 (WorkflowTemplate):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.WorkflowTemplate{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_delete(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Deletes a workflow template. It does not cancel in-progress workflows.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
  • locations_id (String.t): Part of `name`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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").
    • :version (integer()): Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_get(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
  • locations_id (String.t): Part of `name`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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").
    • :version (integer()): Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.WorkflowTemplate{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_get_iam_policy(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (GetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_instantiate(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
  • locations_id (String.t): Part of `name`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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 (InstantiateWorkflowTemplateRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_instantiate_inline(connection, projects_id, locations_id, optional_params \\ [], opts \\ []) View Source

Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `parent`. Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
  • locations_id (String.t): Part of `parent`. See documentation of `projectsId`.

  • 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").
    • :requestId (String.t): Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universallyunique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is 40 characters.
    • :body (WorkflowTemplate):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_list(connection, projects_id, locations_id, optional_params \\ [], opts \\ []) View Source

Lists workflows that match the specified filter in the request.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `parent`. Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
  • locations_id (String.t): Part of `parent`. See documentation of `projectsId`.

  • 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").
    • :pageSize (integer()): Optional. The maximum number of results to return in each response.
    • :pageToken (String.t): Optional. The page token, returned by a previous call, to request the next page of results.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.ListWorkflowTemplatesResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_set_iam_policy(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (SetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_test_iam_permissions(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • locations_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (TestIamPermissionsRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_locations_workflow_templates_update(connection, projects_id, locations_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `template.name`. Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
  • locations_id (String.t): Part of `template.name`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `template.name`. See documentation of `projectsId`.

  • 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 (WorkflowTemplate):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.WorkflowTemplate{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_autoscaling_policies_get_iam_policy(connection, projects_id, regions_id, autoscaling_policies_id, optional_params \\ [], opts \\ []) View Source

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • autoscaling_policies_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (GetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_autoscaling_policies_set_iam_policy(connection, projects_id, regions_id, autoscaling_policies_id, optional_params \\ [], opts \\ []) View Source

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • autoscaling_policies_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (SetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_autoscaling_policies_test_iam_permissions(connection, projects_id, regions_id, autoscaling_policies_id, optional_params \\ [], opts \\ []) View Source

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • autoscaling_policies_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (TestIamPermissionsRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_clusters_create(connection, project_id, region, optional_params \\ [], opts \\ []) View Source

Creates a cluster in a project.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the cluster belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle 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").
    • :requestId (String.t): Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universallyunique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is 40 characters.
    • :body (Cluster):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_clusters_delete(connection, project_id, region, cluster_name, optional_params \\ [], opts \\ []) View Source

Deletes a cluster in a project.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the cluster belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle the request.
  • cluster_name (String.t): Required. The cluster name.

  • 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").
    • :clusterUuid (String.t): Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
    • :requestId (String.t): Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universallyunique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is 40 characters.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_clusters_diagnose(connection, project_id, region, cluster_name, optional_params \\ [], opts \\ []) View Source

Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the cluster belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle the request.
  • cluster_name (String.t): Required. The cluster name.

  • 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 (DiagnoseClusterRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_clusters_get(connection, project_id, region, cluster_name, optional_params \\ [], opts \\ []) View Source

Gets the resource representation for a cluster in a project.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the cluster belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle the request.
  • cluster_name (String.t): Required. The cluster name.

  • 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").

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Cluster{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_clusters_get_iam_policy(connection, projects_id, regions_id, clusters_id, optional_params \\ [], opts \\ []) View Source

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • clusters_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (GetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_clusters_list(connection, project_id, region, optional_params \\ [], opts \\ []) View Source

Lists all regions/{region}/clusters in a project.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the cluster belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle 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").
    • :filter (String.t): Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred =
    • :pageSize (integer()): Optional. The standard List page size.
    • :pageToken (String.t): Optional. The standard List page token.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.ListClustersResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_clusters_patch(connection, project_id, region, cluster_name, optional_params \\ [], opts \\ []) View Source

Updates a cluster in a project.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project the cluster belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle the request.
  • cluster_name (String.t): Required. The cluster name.

  • 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").
    • :gracefulDecommissionTimeout (String.t): Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.
    • :requestId (String.t): Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universallyunique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is 40 characters.
    • :updateMask (String.t): Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } <strong>Note:</strong> Currently, only the following fields can be updated:<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> </tbody> </table>
    • :body (Cluster):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_clusters_set_iam_policy(connection, projects_id, regions_id, clusters_id, optional_params \\ [], opts \\ []) View Source

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • clusters_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (SetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_clusters_test_iam_permissions(connection, projects_id, regions_id, clusters_id, optional_params \\ [], opts \\ []) View Source

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • clusters_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (TestIamPermissionsRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_jobs_cancel(connection, project_id, region, job_id, optional_params \\ [], opts \\ []) View Source

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the job belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle the request.
  • job_id (String.t): Required. 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 (CancelJobRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Job{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_jobs_delete(connection, project_id, region, job_id, optional_params \\ [], opts \\ []) View Source

Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the job belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle the request.
  • job_id (String.t): Required. 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").

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_jobs_get(connection, project_id, region, job_id, optional_params \\ [], opts \\ []) View Source

Gets the resource representation for a job in a project.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the job belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle the request.
  • job_id (String.t): Required. 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").

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Job{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_jobs_get_iam_policy(connection, projects_id, regions_id, jobs_id, optional_params \\ [], opts \\ []) View Source

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • jobs_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (GetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_jobs_list(connection, project_id, region, optional_params \\ [], opts \\ []) View Source

Lists regions/{region}/jobs in a project.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the job belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle 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").
    • :clusterName (String.t): Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
    • :filter (String.t): Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred =
    • :jobStateMatcher (String.t): Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.
    • :pageSize (integer()): Optional. The number of results to return in each response.
    • :pageToken (String.t): Optional. The page token, returned by a previous call, to request the next page of results.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.ListJobsResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_jobs_patch(connection, project_id, region, job_id, optional_params \\ [], opts \\ []) View Source

Updates a job in a project.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the job belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle the request.
  • job_id (String.t): Required. 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").
    • :updateMask (String.t): Required. Specifies the path, relative to <code>Job</code>, of the field to update. For example, to update the labels of a Job the <code>update_mask</code> parameter would be specified as <code>labels</code>, and the PATCH request body would specify the new value. <strong>Note:</strong> Currently, <code>labels</code> is the only field that can be updated.
    • :body (Job):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Job{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_jobs_set_iam_policy(connection, projects_id, regions_id, jobs_id, optional_params \\ [], opts \\ []) View Source

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • jobs_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (SetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_jobs_submit(connection, project_id, region, optional_params \\ [], opts \\ []) View Source

Submits a job to a cluster.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • project_id (String.t): Required. The ID of the Google Cloud Platform project that the job belongs to.
  • region (String.t): Required. The Cloud Dataproc region in which to handle 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 (SubmitJobRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Job{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_jobs_test_iam_permissions(connection, projects_id, regions_id, jobs_id, optional_params \\ [], opts \\ []) View Source

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • jobs_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (TestIamPermissionsRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_operations_cancel(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ []) View Source

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. The name of the operation resource to be cancelled.
  • regions_id (String.t): Part of `name`. See documentation of `projectsId`.
  • operations_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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").

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_operations_delete(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ []) View Source

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. The name of the operation resource to be deleted.
  • regions_id (String.t): Part of `name`. See documentation of `projectsId`.
  • operations_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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").

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_operations_get(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ []) View Source

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. The name of the operation resource.
  • regions_id (String.t): Part of `name`. See documentation of `projectsId`.
  • operations_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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").

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_operations_get_iam_policy(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ []) View Source

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • operations_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (GetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_operations_list(connection, projects_id, regions_id, optional_params \\ [], opts \\ []) View Source

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users//operations. To override the binding, API services can add a binding such as "/v1/{name=users/}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. The name of the operation's parent resource.
  • regions_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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 standard list filter.
    • :pageSize (integer()): The standard list page size.
    • :pageToken (String.t): The standard list page token.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.ListOperationsResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_operations_set_iam_policy(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ []) View Source

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • operations_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (SetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_operations_test_iam_permissions(connection, projects_id, regions_id, operations_id, optional_params \\ [], opts \\ []) View Source

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • operations_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (TestIamPermissionsRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_create(connection, projects_id, regions_id, optional_params \\ [], opts \\ []) View Source

Creates new workflow template.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `parent`. Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
  • regions_id (String.t): Part of `parent`. See documentation of `projectsId`.

  • 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 (WorkflowTemplate):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.WorkflowTemplate{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_delete(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Deletes a workflow template. It does not cancel in-progress workflows.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
  • regions_id (String.t): Part of `name`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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").
    • :version (integer()): Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Empty{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_get(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
  • regions_id (String.t): Part of `name`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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").
    • :version (integer()): Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.WorkflowTemplate{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_get_iam_policy(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (GetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_instantiate(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `name`. Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
  • regions_id (String.t): Part of `name`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `name`. See documentation of `projectsId`.

  • 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 (InstantiateWorkflowTemplateRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_instantiate_inline(connection, projects_id, regions_id, optional_params \\ [], opts \\ []) View Source

Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `parent`. Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
  • regions_id (String.t): Part of `parent`. See documentation of `projectsId`.

  • 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").
    • :requestId (String.t): Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universallyunique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (), and hyphens (-). The maximum length is 40 characters.
    • :body (WorkflowTemplate):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Operation{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_list(connection, projects_id, regions_id, optional_params \\ [], opts \\ []) View Source

Lists workflows that match the specified filter in the request.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `parent`. Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}
  • regions_id (String.t): Part of `parent`. See documentation of `projectsId`.

  • 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").
    • :pageSize (integer()): Optional. The maximum number of results to return in each response.
    • :pageToken (String.t): Optional. The page token, returned by a previous call, to request the next page of results.

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.ListWorkflowTemplatesResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_set_iam_policy(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (SetIamPolicyRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.Policy{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_test_iam_permissions(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `resource`. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • regions_id (String.t): Part of `resource`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `resource`. See documentation of `projectsId`.

  • 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 (TestIamPermissionsRequest):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure

Link to this function

dataproc_projects_regions_workflow_templates_update(connection, projects_id, regions_id, workflow_templates_id, optional_params \\ [], opts \\ []) View Source

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Parameters

  • connection (GoogleApi.Dataproc.V1.Connection): Connection to server
  • projects_id (String.t): Part of `template.name`. Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
  • regions_id (String.t): Part of `template.name`. See documentation of `projectsId`.
  • workflow_templates_id (String.t): Part of `template.name`. See documentation of `projectsId`.

  • 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 (WorkflowTemplate):

Returns

{:ok, %GoogleApi.Dataproc.V1.Model.WorkflowTemplate{}} on success {:error, info} on failure