View Source GoogleApi.VPCAccess.V1.Api.Projects (google_api_vpc_access v0.2.0)

API calls for all endpoints tagged Projects.

Summary

Functions

Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

Lists information about the supported locations for this service.

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.

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Functions

Link to this function

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

View Source
@spec vpcaccess_projects_locations_connectors_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VPCAccess.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a Serverless VPC Access connector, returns an operation.

Parameters

  • connection (type: GoogleApi.VPCAccess.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. The project ID and location in which the configuration should be created, specified in the format projects/*/locations/*.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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").
    • :connectorId (type: String.t) - Required. The ID to use for this connector.
    • :body (type: GoogleApi.VPCAccess.V1.Model.Connector.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.VPCAccess.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

vpcaccess_projects_locations_connectors_delete(connection, projects_id, locations_id, connectors_id, optional_params \\ [], opts \\ [])

View Source
@spec vpcaccess_projects_locations_connectors_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VPCAccess.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

Parameters

  • connection (type: GoogleApi.VPCAccess.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of a Serverless VPC Access connector to delete.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • connectors_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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.VPCAccess.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

vpcaccess_projects_locations_connectors_get(connection, projects_id, locations_id, connectors_id, optional_params \\ [], opts \\ [])

View Source
@spec vpcaccess_projects_locations_connectors_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VPCAccess.V1.Model.Connector.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a Serverless VPC Access connector. Returns NOT_FOUND if the resource does not exist.

Parameters

  • connection (type: GoogleApi.VPCAccess.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. Name of a Serverless VPC Access connector to get.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • connectors_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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.VPCAccess.V1.Model.Connector{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec vpcaccess_projects_locations_connectors_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VPCAccess.V1.Model.ListConnectorsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists Serverless VPC Access connectors.

Parameters

  • connection (type: GoogleApi.VPCAccess.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. The project and location from which the routes should be listed.
  • locations_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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()) - Maximum number of functions to return per call.
    • :pageToken (type: String.t) - Continuation token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.VPCAccess.V1.Model.ListConnectorsResponse{}} on success
  • {:error, info} on failure
Link to this function

vpcaccess_projects_locations_connectors_patch(connection, projects_id, locations_id, connectors_id, optional_params \\ [], opts \\ [])

View Source
@spec vpcaccess_projects_locations_connectors_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VPCAccess.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a Serverless VPC Access connector, returns an operation.

Parameters

  • connection (type: GoogleApi.VPCAccess.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of connector.name. The resource name in the format projects/*/locations/*/connectors/*.
  • locations_id (type: String.t) - Part of connector.name. See documentation of projectsId.
  • connectors_id (type: String.t) - Part of connector.name. See documentation of projectsId.
  • 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) - The fields to update on the entry group. If absent or empty, all modifiable fields are updated.
    • :body (type: GoogleApi.VPCAccess.V1.Model.Connector.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.VPCAccess.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

vpcaccess_projects_locations_list(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
@spec vpcaccess_projects_locations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VPCAccess.V1.Model.ListLocationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists information about the supported locations for this service.

Parameters

  • connection (type: GoogleApi.VPCAccess.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. The resource that owns the locations collection, if applicable.
  • 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").
    • :filter (type: String.t) - A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
    • :pageSize (type: integer()) - The maximum number of results to return. If not set, the service selects a default.
    • :pageToken (type: String.t) - A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.VPCAccess.V1.Model.ListLocationsResponse{}} on success
  • {:error, info} on failure
Link to this function

vpcaccess_projects_locations_operations_get(connection, projects_id, locations_id, operations_id, optional_params \\ [], opts \\ [])

View Source
@spec vpcaccess_projects_locations_operations_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VPCAccess.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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 (type: GoogleApi.VPCAccess.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. The name of the operation resource.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • operations_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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.VPCAccess.V1.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec vpcaccess_projects_locations_operations_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VPCAccess.V1.Model.ListOperationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters

  • connection (type: GoogleApi.VPCAccess.V1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. The name of the operation's parent resource.
  • locations_id (type: String.t) - Part of name. See documentation of projectsId.
  • 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").
    • :filter (type: String.t) - The standard list filter.
    • :pageSize (type: integer()) - The standard list page size.
    • :pageToken (type: String.t) - The standard list page token.
  • opts (type: keyword()) - Call options

Returns

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