View Source GoogleApi.BigQueryConnection.V1.Api.Projects (google_api_big_query_connection v0.12.1)

API calls for all endpoints tagged Projects.

Summary

Functions

bigqueryconnection_projects_locations_connections_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a new connection.

bigqueryconnection_projects_locations_connections_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes connection and associated credential.

bigqueryconnection_projects_locations_connections_get(connection, name, optional_params \\ [], opts \\ [])

Returns specified connection.

bigqueryconnection_projects_locations_connections_get_iam_policy(connection, resource, 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.

bigqueryconnection_projects_locations_connections_list(connection, parent, optional_params \\ [], opts \\ [])

Returns a list of connections in the given project.

bigqueryconnection_projects_locations_connections_patch(connection, name, optional_params \\ [], opts \\ [])

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

bigqueryconnection_projects_locations_connections_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

bigqueryconnection_projects_locations_connections_test_iam_permissions(connection, resource, 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.

Functions

bigqueryconnection_projects_locations_connections_create(connection, parent, optional_params \\ [], opts \\ [])

@spec bigqueryconnection_projects_locations_connections_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryConnection.V1.Model.Connection.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new connection.

Parameters

connection (type: GoogleApi.BigQueryConnection.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. Parent resource name. Must be in the format projects/{project_id}/locations/{location_id}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :connectionId (type: String.t) - Optional. Connection id that should be assigned to the created connection.
- :body (type: GoogleApi.BigQueryConnection.V1.Model.Connection.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.BigQueryConnection.V1.Model.Connection{}} on success
{:error, info} on failure

bigqueryconnection_projects_locations_connections_delete(connection, name, optional_params \\ [], opts \\ [])

@spec bigqueryconnection_projects_locations_connections_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryConnection.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes connection and associated credential.

Parameters

connection (type: GoogleApi.BigQueryConnection.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Name of the deleted connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

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

bigqueryconnection_projects_locations_connections_get(connection, name, optional_params \\ [], opts \\ [])

@spec bigqueryconnection_projects_locations_connections_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryConnection.V1.Model.Connection.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns specified connection.

Parameters

connection (type: GoogleApi.BigQueryConnection.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Name of the requested connection, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.BigQueryConnection.V1.Model.Connection{}} on success
{:error, info} on failure

bigqueryconnection_projects_locations_connections_get_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

@spec bigqueryconnection_projects_locations_connections_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryConnection.V1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 (type: GoogleApi.BigQueryConnection.V1.Connection.t) - Connection to server
resource (type: String.t) - REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.BigQueryConnection.V1.Model.GetIamPolicyRequest.t) -
opts (type: keyword()) - Call options

Returns

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

bigqueryconnection_projects_locations_connections_list(connection, parent, optional_params \\ [], opts \\ [])

@spec bigqueryconnection_projects_locations_connections_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryConnection.V1.Model.ListConnectionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a list of connections in the given project.

Parameters

connection (type: GoogleApi.BigQueryConnection.V1.Connection.t) - Connection to server
parent (type: String.t) - Required. Parent resource name. Must be in the form: projects/{project_id}/locations/{location_id}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :pageSize (type: integer()) - Required. Page size.
- :pageToken (type: String.t) - Page token.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.BigQueryConnection.V1.Model.ListConnectionsResponse{}} on success
{:error, info} on failure

bigqueryconnection_projects_locations_connections_patch(connection, name, optional_params \\ [], opts \\ [])

@spec bigqueryconnection_projects_locations_connections_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryConnection.V1.Model.Connection.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

Parameters

connection (type: GoogleApi.BigQueryConnection.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Name of the connection to update, for example: projects/{project_id}/locations/{location_id}/connections/{connection_id}
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :updateMask (type: String.t) - Required. Update mask for the connection fields to be updated.
- :body (type: GoogleApi.BigQueryConnection.V1.Model.Connection.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.BigQueryConnection.V1.Model.Connection{}} on success
{:error, info} on failure

bigqueryconnection_projects_locations_connections_set_iam_policy(connection, resource, optional_params \\ [], opts \\ [])

@spec bigqueryconnection_projects_locations_connections_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryConnection.V1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters

connection (type: GoogleApi.BigQueryConnection.V1.Connection.t) - Connection to server
resource (type: String.t) - REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.BigQueryConnection.V1.Model.SetIamPolicyRequest.t) -
opts (type: keyword()) - Call options

Returns

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

bigqueryconnection_projects_locations_connections_test_iam_permissions(connection, resource, optional_params \\ [], opts \\ [])

@spec bigqueryconnection_projects_locations_connections_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigQueryConnection.V1.Model.TestIamPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Parameters

connection (type: GoogleApi.BigQueryConnection.V1.Connection.t) - Connection to server
resource (type: String.t) - REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: 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.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :body (type: GoogleApi.BigQueryConnection.V1.Model.TestIamPermissionsRequest.t) -
opts (type: keyword()) - Call options

Returns

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