Secret Manager API . projects . secrets . versions

access(name, x__xgafv=None)

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

Args:
  name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SecretManagerService.AccessSecretVersion.
  "name": "A String", # The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`.
  "payload": { # A secret payload resource in the Secret Manager API. This contains the sensitive secret data that is associated with a SecretVersion. # Secret payload
    "data": "A String", # The secret data. Must be no larger than 64KiB.
  },
}

close()

Close httplib2 connections.

destroy(name, body=None, x__xgafv=None)

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

Args:
  name: string, Required. The resource name of the SecretVersion to destroy in the format `projects/*/secrets/*/versions/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SecretManagerService.DestroySecretVersion.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A secret version resource in the Secret Manager API.
  "createTime": "A String", # Output only. The time at which the SecretVersion was created.
  "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
  "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
  "state": "A String", # Output only. The current state of the SecretVersion.
}

disable(name, body=None, x__xgafv=None)

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

Args:
  name: string, Required. The resource name of the SecretVersion to disable in the format `projects/*/secrets/*/versions/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SecretManagerService.DisableSecretVersion.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A secret version resource in the Secret Manager API.
  "createTime": "A String", # Output only. The time at which the SecretVersion was created.
  "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
  "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
  "state": "A String", # Output only. The current state of the SecretVersion.
}

enable(name, body=None, x__xgafv=None)

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

Args:
  name: string, Required. The resource name of the SecretVersion to enable in the format `projects/*/secrets/*/versions/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for SecretManagerService.EnableSecretVersion.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A secret version resource in the Secret Manager API.
  "createTime": "A String", # Output only. The time at which the SecretVersion was created.
  "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
  "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
  "state": "A String", # Output only. The current state of the SecretVersion.
}

get(name, x__xgafv=None)

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

Args:
  name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the `latest` SecretVersion. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A secret version resource in the Secret Manager API.
  "createTime": "A String", # Output only. The time at which the SecretVersion was created.
  "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
  "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
  "state": "A String", # Output only. The current state of the SecretVersion.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists SecretVersions. This call does not return secret data.

Args:
  parent: string, Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/*/secrets/*`. (required)
  pageSize: 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: string, Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SecretManagerService.ListSecretVersions.
  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in ListSecretVersionsRequest.page_token to retrieve the next page.
  "totalSize": 42, # The total number of SecretVersions.
  "versions": [ # The list of SecretVersions sorted in reverse by create_time (newest first).
    { # A secret version resource in the Secret Manager API.
      "createTime": "A String", # Output only. The time at which the SecretVersion was created.
      "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
      "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
      "state": "A String", # Output only. The current state of the SecretVersion.
    },
  ],
}

list_next(previous_request, previous_response)

Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.