GoogleApi.StorageTransfer.V1.Api.Projects (google_api_storage_transfer v0.32.1) View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

storagetransfer_projects_agent_pools_create(connection, project_id, optional_params \\ [], opts \\ [])

Creates an agent pool resource.

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

Deletes an agent pool.

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

Gets an agent pool.

storagetransfer_projects_agent_pools_list(connection, project_id, optional_params \\ [], opts \\ [])

Lists agent pools.

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

Updates an existing agent pool resource.

Link to this section Functions

storagetransfer_projects_agent_pools_create(connection, project_id, optional_params \\ [], opts \\ [])

Specs

storagetransfer_projects_agent_pools_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.AgentPool.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an agent pool resource.

Parameters

connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
project_id (type: String.t) - Required. The ID of the Google Cloud project that owns the agent pool.
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").
- :agentPoolId (type: String.t) - Required. The ID of the agent pool to create. The agent_pool_id must meet the following requirements: Length of 128 characters or less. Not start with the string goog. Start with a lowercase ASCII character, followed by: Zero or more: lowercase Latin alphabet characters, numerals, hyphens (-), periods (.), underscores (_), or tildes (~). One or more numerals or lowercase ASCII characters. As expressed by the regular expression: `^(?!goog)[a-z]([a-z0-9-._~][a-z0-9])?$`.
- :body (type: GoogleApi.StorageTransfer.V1.Model.AgentPool.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StorageTransfer.V1.Model.AgentPool{}} on success
{:error, info} on failure

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

Specs

storagetransfer_projects_agent_pools_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes an agent pool.

Parameters

connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the agent pool to delete.
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.StorageTransfer.V1.Model.Empty{}} on success
{:error, info} on failure

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

Specs

storagetransfer_projects_agent_pools_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.AgentPool.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets an agent pool.

Parameters

connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
name (type: String.t) - Required. The name of the agent pool to get.
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.StorageTransfer.V1.Model.AgentPool{}} on success
{:error, info} on failure

storagetransfer_projects_agent_pools_list(connection, project_id, optional_params \\ [], opts \\ [])

Specs

storagetransfer_projects_agent_pools_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.ListAgentPoolsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists agent pools.

Parameters

connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
project_id (type: String.t) - Required. The ID of the Google Cloud project that owns the job.
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) - An optional list of query parameters specified as JSON text in the form of: {"agentPoolNames":["agentpool1","agentpool2",...]} Since agentPoolNames support multiple values, its values must be specified with array notation. When the filter is either empty or not provided, the list returns all agent pools for the project.
- :pageSize (type: integer()) - The list page size. The max allowed value is 256.
- :pageToken (type: String.t) - The list page token.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StorageTransfer.V1.Model.ListAgentPoolsResponse{}} on success
{:error, info} on failure

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

Specs

storagetransfer_projects_agent_pools_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.StorageTransfer.V1.Model.AgentPool.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing agent pool resource.

Parameters

connection (type: GoogleApi.StorageTransfer.V1.Connection.t) - Connection to server
name (type: String.t) - Required. Specifies a unique string that identifies the agent pool. Format: projects/{project_id}/agentPools/{agent_pool_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) - The [field mask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the fields in agentPool to update in this request. The following agentPool fields can be updated: display_name bandwidth_limit
- :body (type: GoogleApi.StorageTransfer.V1.Model.AgentPool.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.StorageTransfer.V1.Model.AgentPool{}} on success
{:error, info} on failure