View Source GoogleApi.Storage.V1.Api.AnywhereCaches (google_api_storage v0.45.0)

@spec storage_anywhere_caches_disable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.AnywhereCache.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Disables an Anywhere Cache instance.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the parent bucket.
anywhere_cache_id (type: String.t) - The ID of requested Anywhere Cache instance.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.AnywhereCache{}} on success
{:error, info} on failure

storage_anywhere_caches_get(connection, bucket, anywhere_cache_id, optional_params \\ [], opts \\ [])

@spec storage_anywhere_caches_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.AnywhereCache.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns the metadata of an Anywhere Cache instance.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the parent bucket.
anywhere_cache_id (type: String.t) - The ID of requested Anywhere Cache instance.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.AnywhereCache{}} on success
{:error, info} on failure

storage_anywhere_caches_insert(connection, bucket, optional_params \\ [], opts \\ [])

@spec storage_anywhere_caches_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates an Anywhere Cache instance.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the parent bucket.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Storage.V1.Model.AnywhereCache.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.GoogleLongrunningOperation{}} on success
{:error, info} on failure

storage_anywhere_caches_list(connection, bucket, optional_params \\ [], opts \\ [])

@spec storage_anywhere_caches_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.AnywhereCaches.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns a list of Anywhere Cache instances of the bucket matching the criteria.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the parent bucket.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :pageSize (type: integer()) - Maximum number of items to return in a single page of responses. Maximum 1000.
- :pageToken (type: String.t) - A previously-returned page token representing part of the larger set of results to view.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.AnywhereCaches{}} on success
{:error, info} on failure

storage_anywhere_caches_pause(connection, bucket, anywhere_cache_id, optional_params \\ [], opts \\ [])

@spec storage_anywhere_caches_pause(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.AnywhereCache.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Pauses an Anywhere Cache instance.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the parent bucket.
anywhere_cache_id (type: String.t) - The ID of requested Anywhere Cache instance.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.AnywhereCache{}} on success
{:error, info} on failure

storage_anywhere_caches_resume(connection, bucket, anywhere_cache_id, optional_params \\ [], opts \\ [])

@spec storage_anywhere_caches_resume(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.AnywhereCache.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Resumes a paused or disabled Anywhere Cache instance.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the parent bucket.
anywhere_cache_id (type: String.t) - The ID of requested Anywhere Cache instance.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.AnywhereCache{}} on success
{:error, info} on failure

storage_anywhere_caches_update(connection, bucket, anywhere_cache_id, optional_params \\ [], opts \\ [])

@spec storage_anywhere_caches_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the parent bucket.
anywhere_cache_id (type: String.t) - The ID of requested Anywhere Cache instance.
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Storage.V1.Model.AnywhereCache.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Storage.V1.Model.GoogleLongrunningOperation{}} on success
{:error, info} on failure