GoogleApi.StorageTransfer.V1.Api.Projects (google_api_storage_transfer v0.31.0) View Source
API calls for all endpoints tagged Projects
.
Link to this section Summary
Functions
Creates an agent pool resource.
Deletes an agent pool.
Gets an agent pool.
storagetransfer_projects_agent_pools_list(connection, project_id, optional_params \\ [], opts \\ [])
Lists agent pools.
Updates an existing agent pool resource.
Link to this section Functions
Link to this function
storagetransfer_projects_agent_pools_create(connection, project_id, optional_params \\ [], opts \\ [])
View SourceSpecs
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 Platform Console 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 agentpool_id must be non-empty, less than or equal to 128 characters, and satisfy the following regex: "^[a-z]([a-z0-9-.~]*[a-z0-9])?$". Also, agent pool names cannot start with the string "goog". -
: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
Link to this function
storagetransfer_projects_agent_pools_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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 agent pool name 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
Link to this function
storagetransfer_projects_agent_pools_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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 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
Link to this function
storagetransfer_projects_agent_pools_list(connection, project_id, optional_params \\ [], opts \\ [])
View SourceSpecs
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 Platform Console 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
) - A list of optional query parameters specified as JSON text in the form of:{"agentPoolNames":["agentpool1","agentpool2",...]}
SinceagentPoolNames
support multiple values, its values must be specified with array notation.agentPoolNames
is an optional field. The list returns all agent pools for the project when the filter is not provided or empty. -
: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
Link to this function
storagetransfer_projects_agent_pools_patch(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
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 of the fields inagentPool
that are to be updated in this request. Fields inagentPool
that can be updated are: 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