google_api_secret_manager v0.19.0

View Source GoogleApi.SecretManager.V1beta1.Api.Projects (google_api_secret_manager v0.19.0)

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

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

Gets information about a location.

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

Lists information about the supported locations for this service.

secretmanager_projects_secrets_add_version(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

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

Creates a new Secret containing no SecretVersions.

secretmanager_projects_secrets_delete(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

Deletes a Secret.

secretmanager_projects_secrets_get(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

Gets metadata for a given Secret.

secretmanager_projects_secrets_get_iam_policy(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.

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

Lists Secrets.

secretmanager_projects_secrets_patch(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

Updates metadata of an existing Secret.

secretmanager_projects_secrets_set_iam_policy(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.

secretmanager_projects_secrets_test_iam_permissions(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns 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.

secretmanager_projects_secrets_versions_access(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

Accesses a SecretVersion. This call returns the secret data. projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.

secretmanager_projects_secrets_versions_destroy(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.

secretmanager_projects_secrets_versions_disable(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.

secretmanager_projects_secrets_versions_enable(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.

secretmanager_projects_secrets_versions_get(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

Gets metadata for a SecretVersion. projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.

secretmanager_projects_secrets_versions_list(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

Lists SecretVersions. This call does not return secret data.

Link to this section Functions

Link to this function

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

View Source

Specs

secretmanager_projects_locations_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.Location.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets information about a location.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Resource name for the location.
  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.Location{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

secretmanager_projects_locations_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.ListLocationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists information about the supported locations for this service.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.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.SecretManager.V1beta1.Model.ListLocationsResponse{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_add_version(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_add_version(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.SecretVersion.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new SecretVersion containing secret data and attaches it to an existing Secret.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. The resource name of the Secret to associate with the SecretVersion in the format projects/*/secrets/*.
  • secrets_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").
    • :body (type: GoogleApi.SecretManager.V1beta1.Model.AddSecretVersionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.SecretVersion{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

secretmanager_projects_secrets_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.Secret.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new Secret containing no SecretVersions.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. The resource name of the project to associate with the Secret, in the format projects/*.
  • 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").
    • :secretId (type: String.t) - Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (-) and underscore (_) characters.
    • :body (type: GoogleApi.SecretManager.V1beta1.Model.Secret.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.Secret{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_delete(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a Secret.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The resource name of the Secret to delete in the format projects/*/secrets/*.
  • secrets_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.SecretManager.V1beta1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_get(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.Secret.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets metadata for a given Secret.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The resource name of the Secret, in the format projects/*/secrets/*.
  • secrets_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.SecretManager.V1beta1.Model.Secret{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_get_iam_policy(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • secrets_id (type: String.t) - Part of resource. 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").
    • :"options.requestedPolicyVersion" (type: integer()) - Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

secretmanager_projects_secrets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.ListSecretsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists Secrets.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. The resource name of the project associated with the Secrets, in the format projects/*.
  • 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()) - Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.
    • :pageToken (type: String.t) - Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.ListSecretsResponse{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_patch(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.Secret.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates metadata of an existing Secret.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of secret.name. Output only. The resource name of the Secret in the format projects/*/secrets/*.
  • secrets_id (type: String.t) - Part of secret.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) - Required. Specifies the fields to be updated.
    • :body (type: GoogleApi.SecretManager.V1beta1.Model.Secret.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.Secret{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_set_iam_policy(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • secrets_id (type: String.t) - Part of resource. 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").
    • :body (type: GoogleApi.SecretManager.V1beta1.Model.SetIamPolicyRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.Policy{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_test_iam_permissions(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.TestIamPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns 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.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of resource. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • secrets_id (type: String.t) - Part of resource. 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").
    • :body (type: GoogleApi.SecretManager.V1beta1.Model.TestIamPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.TestIamPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_versions_access(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_versions_access(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.AccessSecretVersionResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Accesses a SecretVersion. This call returns the secret data. projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The resource name of the SecretVersion in the format projects/*/secrets/*/versions/*.
  • secrets_id (type: String.t) - Part of name. See documentation of projectsId.
  • versions_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.SecretManager.V1beta1.Model.AccessSecretVersionResponse{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_versions_destroy(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_versions_destroy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.SecretVersion.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The resource name of the SecretVersion to destroy in the format projects/*/secrets/*/versions/*.
  • secrets_id (type: String.t) - Part of name. See documentation of projectsId.
  • versions_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").
    • :body (type: GoogleApi.SecretManager.V1beta1.Model.DestroySecretVersionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.SecretVersion{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_versions_disable(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_versions_disable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.SecretVersion.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The resource name of the SecretVersion to disable in the format projects/*/secrets/*/versions/*.
  • secrets_id (type: String.t) - Part of name. See documentation of projectsId.
  • versions_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").
    • :body (type: GoogleApi.SecretManager.V1beta1.Model.DisableSecretVersionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.SecretVersion{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_versions_enable(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_versions_enable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.SecretVersion.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The resource name of the SecretVersion to enable in the format projects/*/secrets/*/versions/*.
  • secrets_id (type: String.t) - Part of name. See documentation of projectsId.
  • versions_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").
    • :body (type: GoogleApi.SecretManager.V1beta1.Model.EnableSecretVersionRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.SecretVersion{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_versions_get(connection, projects_id, secrets_id, versions_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_versions_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.SecretVersion.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets metadata for a SecretVersion. projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of name. Required. The resource name of the SecretVersion in the format projects/*/secrets/*/versions/*. projects/*/secrets/*/versions/latest is an alias to the latest SecretVersion.
  • secrets_id (type: String.t) - Part of name. See documentation of projectsId.
  • versions_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.SecretManager.V1beta1.Model.SecretVersion{}} on success
  • {:error, info} on failure
Link to this function

secretmanager_projects_secrets_versions_list(connection, projects_id, secrets_id, optional_params \\ [], opts \\ [])

View Source

Specs

secretmanager_projects_secrets_versions_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SecretManager.V1beta1.Model.ListSecretVersionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists SecretVersions. This call does not return secret data.

Parameters

  • connection (type: GoogleApi.SecretManager.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. The resource name of the Secret associated with the SecretVersions to list, in the format projects/*/secrets/*.
  • secrets_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()) - Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.
    • :pageToken (type: String.t) - Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SecretManager.V1beta1.Model.ListSecretVersionsResponse{}} on success
  • {:error, info} on failure