secretmanager

package
v0.213.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 17, 2024 License: BSD-3-Clause Imports: 18 Imported by: 13

Documentation

Overview

Package secretmanager provides access to the Secret Manager API.

For product documentation, see: https://cloud.google.com/secret-manager/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example: 

import "google.golang.org/api/secretmanager/v1"
...
ctx := context.Background()
secretmanagerService, err := secretmanager.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey: 

secretmanagerService, err := secretmanager.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
secretmanagerService, err := secretmanager.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source 
const (
	// See, edit, configure, and delete your Google Cloud data and see the email
	// address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessSecretVersionResponse 

type AccessSecretVersionResponse struct {
	// Name: The resource name of the SecretVersion in the format
	// `projects/*/secrets/*/versions/*` or
	// `projects/*/locations/*/secrets/*/versions/*`.
	Name string `json:"name,omitempty"`
	// Payload: Secret payload
	Payload *SecretPayload `json:"payload,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AccessSecretVersionResponse: Response message for SecretManagerService.AccessSecretVersion.

func (AccessSecretVersionResponse) MarshalJSON 

func (s AccessSecretVersionResponse) MarshalJSON() ([]byte, error)

type AddSecretVersionRequest 

type AddSecretVersionRequest struct {
	// Payload: Required. The secret payload of the SecretVersion.
	Payload *SecretPayload `json:"payload,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Payload") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Payload") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AddSecretVersionRequest: Request message for SecretManagerService.AddSecretVersion.

func (AddSecretVersionRequest) MarshalJSON 

func (s AddSecretVersionRequest) MarshalJSON() ([]byte, error)

type AuditConfig 

type AuditConfig struct {
	// AuditLogConfigs: The configuration for logging of each type of permission.
	AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
	// Service: Specifies a service that will be enabled for audit logging. For
	// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`
	// is a special value that covers all services.
	Service string `json:"service,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditLogConfigs") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

func (AuditConfig) MarshalJSON 

func (s AuditConfig) MarshalJSON() ([]byte, error)

type AuditLogConfig 

type AuditLogConfig struct {
	// ExemptedMembers: Specifies the identities that do not cause logging for this
	// type of permission. Follows the same format of Binding.members.
	ExemptedMembers []string `json:"exemptedMembers,omitempty"`
	// LogType: The log type that this config enables.
	//
	// Possible values:
	//   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
	//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
	//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create
	//   "DATA_READ" - Data reads. Example: CloudSQL Users list
	LogType string `json:"logType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ExemptedMembers") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AuditLogConfig: Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

func (AuditLogConfig) MarshalJSON 

func (s AuditLogConfig) MarshalJSON() ([]byte, error)

type Automatic 

type Automatic struct {
	// CustomerManagedEncryption: Optional. The customer-managed encryption
	// configuration of the Secret. If no configuration is provided, Google-managed
	// default encryption is used. Updates to the Secret encryption configuration
	// only apply to SecretVersions added afterwards. They do not apply
	// retroactively to existing SecretVersions.
	CustomerManagedEncryption *CustomerManagedEncryption `json:"customerManagedEncryption,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomerManagedEncryption")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CustomerManagedEncryption") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Automatic: A replication policy that replicates the Secret payload without any restrictions.

func (Automatic) MarshalJSON added in v0.32.0 

func (s Automatic) MarshalJSON() ([]byte, error)

type AutomaticStatus added in v0.32.0 

type AutomaticStatus struct {
	// CustomerManagedEncryption: Output only. The customer-managed encryption
	// status of the SecretVersion. Only populated if customer-managed encryption
	// is used.
	CustomerManagedEncryption *CustomerManagedEncryptionStatus `json:"customerManagedEncryption,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomerManagedEncryption")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CustomerManagedEncryption") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

AutomaticStatus: The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy.

func (AutomaticStatus) MarshalJSON added in v0.32.0 

func (s AutomaticStatus) MarshalJSON() ([]byte, error)

type Binding 

type Binding struct {
	// Condition: The condition that is associated with this binding. If the
	// condition evaluates to `true`, then this binding applies to the current
	// request. If the condition evaluates to `false`, then this binding does not
	// apply to the current request. However, a different role binding might grant
	// the same role to one or more of the principals in this binding. To learn
	// which resources support conditions in their IAM policies, see the IAM
	// documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `json:"condition,omitempty"`
	// Members: Specifies the principals requesting access for a Google Cloud
	// resource. `members` can have the following values: * `allUsers`: A special
	// identifier that represents anyone who is on the internet; with or without a
	// Google account. * `allAuthenticatedUsers`: A special identifier that
	// represents anyone who is authenticated with a Google account or a service
	// account. Does not include identities that come from external identity
	// providers (IdPs) through identity federation. * `user:{emailid}`: An email
	// address that represents a specific Google account. For example,
	// `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
	// represents a Google service account. For example,
	// `my-other-app@appspot.gserviceaccount.com`. *
	// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
	// identifier for a Kubernetes service account
	// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
	// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
	// `group:{emailid}`: An email address that represents a Google group. For
	// example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
	// (primary) that represents all the users of that domain. For example,
	// `google.com` or `example.com`. *
	// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/sub
	// ject/{subject_attribute_value}`: A single identity in a workforce identity
	// pool. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// group/{group_id}`: All workforce identities in a group. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// attribute.{attribute_name}/{attribute_value}`: All workforce identities with
	// a specific attribute value. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/
	// *`: All identities in a workforce identity pool. *
	// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo
	// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
	// identity in a workload identity pool. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool
	// group. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}
	// `: All identities in a workload identity pool with a certain attribute. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations/global
	// /workloadIdentityPools/{pool_id}/*`: All identities in a workload identity
	// pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a user that has been recently deleted. For
	// example, `alice@example.com?uid=123456789012345678901`. If the user is
	// recovered, this value reverts to `user:{emailid}` and the recovered user
	// retains the role in the binding. *
	// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
	// unique identifier) representing a service account that has been recently
	// deleted. For example,
	// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the
	// service account is undeleted, this value reverts to
	// `serviceAccount:{emailid}` and the undeleted service account retains the
	// role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email
	// address (plus unique identifier) representing a Google group that has been
	// recently deleted. For example,
	// `admins@example.com?uid=123456789012345678901`. If the group is recovered,
	// this value reverts to `group:{emailid}` and the recovered group retains the
	// role in the binding. *
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool
	// _id}/subject/{subject_attribute_value}`: Deleted single identity in a
	// workforce identity pool. For example,
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-po
	// ol-id/subject/my-subject-attribute-value`.
	Members []string `json:"members,omitempty"`
	// Role: Role that is assigned to the list of `members`, or principals. For
	// example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview
	// of the IAM roles and permissions, see the IAM documentation
	// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
	// available pre-defined roles, see here
	// (https://cloud.google.com/iam/docs/understanding-roles).
	Role string `json:"role,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Condition") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Condition") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Binding: Associates `members`, or principals, with a `role`.

func (Binding) MarshalJSON 

func (s Binding) MarshalJSON() ([]byte, error)

type CustomerManagedEncryption added in v0.32.0 

type CustomerManagedEncryption struct {
	// KmsKeyName: Required. The resource name of the Cloud KMS CryptoKey used to
	// encrypt secret payloads. For secrets using the UserManaged replication
	// policy type, Cloud KMS CryptoKeys must reside in the same location as the
	// replica location. For secrets using the Automatic replication policy type,
	// Cloud KMS CryptoKeys must reside in `global`. The expected format is
	// `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
	KmsKeyName string `json:"kmsKeyName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KmsKeyName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KmsKeyName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CustomerManagedEncryption: Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).

func (CustomerManagedEncryption) MarshalJSON added in v0.32.0 

func (s CustomerManagedEncryption) MarshalJSON() ([]byte, error)

type CustomerManagedEncryptionStatus added in v0.32.0 

type CustomerManagedEncryptionStatus struct {
	// KmsKeyVersionName: Required. The resource name of the Cloud KMS
	// CryptoKeyVersion used to encrypt the secret payload, in the following
	// format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
	KmsKeyVersionName string `json:"kmsKeyVersionName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KmsKeyVersionName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "KmsKeyVersionName") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

CustomerManagedEncryptionStatus: Describes the status of customer-managed encryption.

func (CustomerManagedEncryptionStatus) MarshalJSON added in v0.32.0 

func (s CustomerManagedEncryptionStatus) MarshalJSON() ([]byte, error)

type DestroySecretVersionRequest 

type DestroySecretVersionRequest struct {
	// Etag: Optional. Etag of the SecretVersion. The request succeeds if it
	// matches the etag of the currently stored secret version object. If the etag
	// is omitted, the request succeeds.
	Etag string `json:"etag,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DestroySecretVersionRequest: Request message for SecretManagerService.DestroySecretVersion.

func (DestroySecretVersionRequest) MarshalJSON added in v0.47.0 

func (s DestroySecretVersionRequest) MarshalJSON() ([]byte, error)

type DisableSecretVersionRequest 

type DisableSecretVersionRequest struct {
	// Etag: Optional. Etag of the SecretVersion. The request succeeds if it
	// matches the etag of the currently stored secret version object. If the etag
	// is omitted, the request succeeds.
	Etag string `json:"etag,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

DisableSecretVersionRequest: Request message for SecretManagerService.DisableSecretVersion.

func (DisableSecretVersionRequest) MarshalJSON added in v0.47.0 

func (s DisableSecretVersionRequest) MarshalJSON() ([]byte, error)

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type EnableSecretVersionRequest 

type EnableSecretVersionRequest struct {
	// Etag: Optional. Etag of the SecretVersion. The request succeeds if it
	// matches the etag of the currently stored secret version object. If the etag
	// is omitted, the request succeeds.
	Etag string `json:"etag,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Etag") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Etag") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

EnableSecretVersionRequest: Request message for SecretManagerService.EnableSecretVersion.

func (EnableSecretVersionRequest) MarshalJSON added in v0.47.0 

func (s EnableSecretVersionRequest) MarshalJSON() ([]byte, error)

type Expr 

type Expr struct {
	// Description: Optional. Description of the expression. This is a longer text
	// which describes the expression, e.g. when hovered over it in a UI.
	Description string `json:"description,omitempty"`
	// Expression: Textual representation of an expression in Common Expression
	// Language syntax.
	Expression string `json:"expression,omitempty"`
	// Location: Optional. String indicating the location of the expression for
	// error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`
	// Title: Optional. Title for the expression, i.e. a short string describing
	// its purpose. This can be used e.g. in UIs which allow to enter the
	// expression.
	Title string `json:"title,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Description") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (Expr) MarshalJSON 

func (s Expr) MarshalJSON() ([]byte, error)

type ListLocationsResponse 

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in the
	// request.
	Locations []*Location `json:"locations,omitempty"`
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Locations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON 

func (s ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListSecretVersionsResponse 

type ListSecretVersionsResponse struct {
	// NextPageToken: A token to retrieve the next page of results. Pass this value
	// in ListSecretVersionsRequest.page_token to retrieve the next page.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// TotalSize: The total number of SecretVersions but 0 when the
	// ListSecretsRequest.filter field is set.
	TotalSize int64 `json:"totalSize,omitempty"`
	// Versions: The list of SecretVersions sorted in reverse by create_time
	// (newest first).
	Versions []*SecretVersion `json:"versions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListSecretVersionsResponse: Response message for SecretManagerService.ListSecretVersions.

func (ListSecretVersionsResponse) MarshalJSON 

func (s ListSecretVersionsResponse) MarshalJSON() ([]byte, error)

type ListSecretsResponse 

type ListSecretsResponse struct {
	// NextPageToken: A token to retrieve the next page of results. Pass this value
	// in ListSecretsRequest.page_token to retrieve the next page.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Secrets: The list of Secrets sorted in reverse by create_time (newest
	// first).
	Secrets []*Secret `json:"secrets,omitempty"`
	// TotalSize: The total number of Secrets but 0 when the
	// ListSecretsRequest.filter field is set.
	TotalSize int64 `json:"totalSize,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextPageToken") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ListSecretsResponse: Response message for SecretManagerService.ListSecrets.

func (ListSecretsResponse) MarshalJSON 

func (s ListSecretsResponse) MarshalJSON() ([]byte, error)

type Location 

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby city
	// name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`
	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`
	// LocationId: The canonical id for this location. For example: "us-east1".
	LocationId string `json:"locationId,omitempty"`
	// Metadata: Service-specific metadata. For example the available capacity at
	// the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "DisplayName") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON 

func (s Location) MarshalJSON() ([]byte, error)

type Policy 

type Policy struct {
	// AuditConfigs: Specifies cloud audit logging configuration for this policy.
	AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
	// Bindings: Associates a list of `members`, or principals, with a `role`.
	// Optionally, may specify a `condition` that determines how and when the
	// `bindings` are applied. Each of the `bindings` must contain at least one
	// principal. The `bindings` in a `Policy` can refer to up to 1,500 principals;
	// up to 250 of these principals can be Google groups. Each occurrence of a
	// principal counts towards these limits. For example, if the `bindings` grant
	// 50 different roles to `user:alice@example.com`, and not to any other
	// principal, then you can add another 1,450 principals to the `bindings` in
	// the `Policy`.
	Bindings []*Binding `json:"bindings,omitempty"`
	// Etag: `etag` is used for optimistic concurrency control as a way to help
	// prevent simultaneous updates of a policy from overwriting each other. It is
	// strongly suggested that systems make use of the `etag` in the
	// read-modify-write cycle to perform policy updates in order to avoid race
	// conditions: An `etag` is returned in the response to `getIamPolicy`, and
	// systems are expected to put that etag in the request to `setIamPolicy` to
	// ensure that their change will be applied to the same version of the policy.
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost.
	Etag string `json:"etag,omitempty"`
	// Version: Specifies the format of the policy. Valid values are `0`, `1`, and
	// `3`. Requests that specify an invalid value are rejected. Any operation that
	// affects conditional role bindings must specify version `3`. This requirement
	// applies to the following operations: * Getting a policy that includes a
	// conditional role binding * Adding a conditional role binding to a policy *
	// Changing a conditional role binding in a policy * Removing any role binding,
	// with or without a condition, from a policy that includes conditions
	// **Important:** If you use IAM Conditions, you must include the `etag` field
	// whenever you call `setIamPolicy`. If you omit this field, then IAM allows
	// you to overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost. If a policy does not
	// include any conditions, operations on that policy may specify any valid
	// version or leave the field unset. To learn which resources support
	// conditions in their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int64 `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AuditConfigs") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "AuditConfigs") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy) MarshalJSON 

func (s Policy) MarshalJSON() ([]byte, error)

type ProjectsLocationsGetCall 

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context 

func (c *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsGetCall) Do 

func (c *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, error)

Do executes the "secretmanager.projects.locations.get" call. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields 

func (c *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsGetCall) Header 

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch 

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsListCall 

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context 

func (c *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsListCall) Do 

func (c *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, error)

Do executes the "secretmanager.projects.locations.list" call. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields 

func (c *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsListCall) Filter 

func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall

Filter sets the optional parameter "filter": 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 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header 

func (c *ProjectsLocationsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch 

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsListCall) PageSize 

func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken 

func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages 

func (c *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsSecretsAddVersionCall added in v0.162.0 

type ProjectsLocationsSecretsAddVersionCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsAddVersionCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsAddVersionCall) Context(ctx context.Context) *ProjectsLocationsSecretsAddVersionCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsAddVersionCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsAddVersionCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.locations.secrets.addVersion" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsAddVersionCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsAddVersionCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsAddVersionCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsAddVersionCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsAddVersionCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsSecretsCreateCall added in v0.162.0 

type ProjectsLocationsSecretsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsCreateCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsCreateCall) Context(ctx context.Context) *ProjectsLocationsSecretsCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsCreateCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsCreateCall) Do(opts ...googleapi.CallOption) (*Secret, error)

Do executes the "secretmanager.projects.locations.secrets.create" call. Any non-2xx status code is an error. Response headers are in either *Secret.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsCreateCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsCreateCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsSecretsCreateCall) SecretId added in v0.162.0 

func (c *ProjectsLocationsSecretsCreateCall) SecretId(secretId string) *ProjectsLocationsSecretsCreateCall

SecretId sets the optional parameter "secretId": 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.

type ProjectsLocationsSecretsDeleteCall added in v0.162.0 

type ProjectsLocationsSecretsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsDeleteCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsDeleteCall) Context(ctx context.Context) *ProjectsLocationsSecretsDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsDeleteCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "secretmanager.projects.locations.secrets.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsDeleteCall) Etag added in v0.162.0 

func (c *ProjectsLocationsSecretsDeleteCall) Etag(etag string) *ProjectsLocationsSecretsDeleteCall

Etag sets the optional parameter "etag": Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds.

func (*ProjectsLocationsSecretsDeleteCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsDeleteCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsSecretsGetCall added in v0.162.0 

type ProjectsLocationsSecretsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsGetCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsGetCall) Context(ctx context.Context) *ProjectsLocationsSecretsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsGetCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsGetCall) Do(opts ...googleapi.CallOption) (*Secret, error)

Do executes the "secretmanager.projects.locations.secrets.get" call. Any non-2xx status code is an error. Response headers are in either *Secret.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsGetCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsGetCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsSecretsGetCall) IfNoneMatch added in v0.162.0 

func (c *ProjectsLocationsSecretsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsSecretsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsSecretsGetIamPolicyCall added in v0.162.0 

type ProjectsLocationsSecretsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsGetIamPolicyCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsSecretsGetIamPolicyCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsGetIamPolicyCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "secretmanager.projects.locations.secrets.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsGetIamPolicyCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsGetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsGetIamPolicyCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsGetIamPolicyCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsSecretsGetIamPolicyCall) IfNoneMatch added in v0.162.0 

func (c *ProjectsLocationsSecretsGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsLocationsSecretsGetIamPolicyCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsSecretsGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.162.0 

func (c *ProjectsLocationsSecretsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsSecretsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": 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 (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsSecretsListCall added in v0.162.0 

type ProjectsLocationsSecretsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsListCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsListCall) Context(ctx context.Context) *ProjectsLocationsSecretsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsListCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsListCall) Do(opts ...googleapi.CallOption) (*ListSecretsResponse, error)

Do executes the "secretmanager.projects.locations.secrets.list" call. Any non-2xx status code is an error. Response headers are in either *ListSecretsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsListCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsListCall) Filter added in v0.162.0 

func (c *ProjectsLocationsSecretsListCall) Filter(filter string) *ProjectsLocationsSecretsListCall

Filter sets the optional parameter "filter": Filter string, adhering to the rules in List-operation filtering (https://cloud.google.com/secret-manager/docs/filtering). List only secrets matching the filter. If filter is empty, all secrets are listed.

func (*ProjectsLocationsSecretsListCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsSecretsListCall) IfNoneMatch added in v0.162.0 

func (c *ProjectsLocationsSecretsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsSecretsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsSecretsListCall) PageSize added in v0.162.0 

func (c *ProjectsLocationsSecretsListCall) PageSize(pageSize int64) *ProjectsLocationsSecretsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsLocationsSecretsListCall) PageToken added in v0.162.0 

func (c *ProjectsLocationsSecretsListCall) PageToken(pageToken string) *ProjectsLocationsSecretsListCall

PageToken sets the optional parameter "pageToken": Pagination token, returned earlier via ListSecretsResponse.next_page_token.

func (*ProjectsLocationsSecretsListCall) Pages added in v0.162.0 

func (c *ProjectsLocationsSecretsListCall) Pages(ctx context.Context, f func(*ListSecretsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsSecretsPatchCall added in v0.162.0 

type ProjectsLocationsSecretsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsPatchCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsPatchCall) Context(ctx context.Context) *ProjectsLocationsSecretsPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsPatchCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsPatchCall) Do(opts ...googleapi.CallOption) (*Secret, error)

Do executes the "secretmanager.projects.locations.secrets.patch" call. Any non-2xx status code is an error. Response headers are in either *Secret.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsPatchCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsPatchCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsSecretsPatchCall) UpdateMask added in v0.162.0 

func (c *ProjectsLocationsSecretsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsSecretsPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Specifies the fields to be updated.

type ProjectsLocationsSecretsService added in v0.162.0 

type ProjectsLocationsSecretsService struct {
	Versions *ProjectsLocationsSecretsVersionsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsSecretsService added in v0.162.0 

func NewProjectsLocationsSecretsService(s *Service) *ProjectsLocationsSecretsService

func (*ProjectsLocationsSecretsService) AddVersion added in v0.162.0 

func (r *ProjectsLocationsSecretsService) AddVersion(parent string, addsecretversionrequest *AddSecretVersionRequest) *ProjectsLocationsSecretsAddVersionCall

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

  • parent: The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.

func (*ProjectsLocationsSecretsService) Create added in v0.162.0 

func (r *ProjectsLocationsSecretsService) Create(parent string, secret *Secret) *ProjectsLocationsSecretsCreateCall

Create: Creates a new Secret containing no SecretVersions.

  • parent: The resource name of the project to associate with the Secret, in the format `projects/*` or `projects/*/locations/*`.

func (*ProjectsLocationsSecretsService) Delete added in v0.162.0 

func (r *ProjectsLocationsSecretsService) Delete(name string) *ProjectsLocationsSecretsDeleteCall

Delete: Deletes a Secret.

  • name: The resource name of the Secret to delete in the format `projects/*/secrets/*`.

func (*ProjectsLocationsSecretsService) Get added in v0.162.0 

func (r *ProjectsLocationsSecretsService) Get(name string) *ProjectsLocationsSecretsGetCall

Get: Gets metadata for a given Secret.

  • name: The resource name of the Secret, in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.

func (*ProjectsLocationsSecretsService) GetIamPolicy added in v0.162.0 

func (r *ProjectsLocationsSecretsService) GetIamPolicy(resource string) *ProjectsLocationsSecretsGetIamPolicyCall

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

func (*ProjectsLocationsSecretsService) List added in v0.162.0 

func (r *ProjectsLocationsSecretsService) List(parent string) *ProjectsLocationsSecretsListCall

List: Lists Secrets.

  • parent: The resource name of the project associated with the Secrets, in the format `projects/*` or `projects/*/locations/*`.

func (*ProjectsLocationsSecretsService) Patch added in v0.162.0 

func (r *ProjectsLocationsSecretsService) Patch(name string, secret *Secret) *ProjectsLocationsSecretsPatchCall

Patch: Updates metadata of an existing Secret.

  • name: Output only. The resource name of the Secret in the format `projects/*/secrets/*`.

func (*ProjectsLocationsSecretsService) SetIamPolicy added in v0.162.0 

func (r *ProjectsLocationsSecretsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsSecretsSetIamPolicyCall

SetIamPolicy: 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.

func (*ProjectsLocationsSecretsService) TestIamPermissions added in v0.162.0 

func (r *ProjectsLocationsSecretsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsSecretsTestIamPermissionsCall

TestIamPermissions: 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.

type ProjectsLocationsSecretsSetIamPolicyCall added in v0.162.0 

type ProjectsLocationsSecretsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsSetIamPolicyCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsSecretsSetIamPolicyCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsSetIamPolicyCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "secretmanager.projects.locations.secrets.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsSetIamPolicyCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsSetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsSetIamPolicyCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsSetIamPolicyCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsSecretsTestIamPermissionsCall added in v0.162.0 

type ProjectsLocationsSecretsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsTestIamPermissionsCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsSecretsTestIamPermissionsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsTestIamPermissionsCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "secretmanager.projects.locations.secrets.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsTestIamPermissionsCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsTestIamPermissionsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsTestIamPermissionsCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsTestIamPermissionsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsSecretsVersionsAccessCall added in v0.162.0 

type ProjectsLocationsSecretsVersionsAccessCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsVersionsAccessCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsAccessCall) Context(ctx context.Context) *ProjectsLocationsSecretsVersionsAccessCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsVersionsAccessCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsAccessCall) Do(opts ...googleapi.CallOption) (*AccessSecretVersionResponse, error)

Do executes the "secretmanager.projects.locations.secrets.versions.access" call. Any non-2xx status code is an error. Response headers are in either *AccessSecretVersionResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsAccessCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsAccessCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsVersionsAccessCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsVersionsAccessCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsAccessCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsSecretsVersionsAccessCall) IfNoneMatch added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsAccessCall) IfNoneMatch(entityTag string) *ProjectsLocationsSecretsVersionsAccessCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsSecretsVersionsDestroyCall added in v0.162.0 

type ProjectsLocationsSecretsVersionsDestroyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsVersionsDestroyCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsDestroyCall) Context(ctx context.Context) *ProjectsLocationsSecretsVersionsDestroyCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsVersionsDestroyCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsDestroyCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.locations.secrets.versions.destroy" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsDestroyCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsDestroyCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsVersionsDestroyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsVersionsDestroyCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsDestroyCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsSecretsVersionsDisableCall added in v0.162.0 

type ProjectsLocationsSecretsVersionsDisableCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsVersionsDisableCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsDisableCall) Context(ctx context.Context) *ProjectsLocationsSecretsVersionsDisableCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsVersionsDisableCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsDisableCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.locations.secrets.versions.disable" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsDisableCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsDisableCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsVersionsDisableCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsVersionsDisableCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsDisableCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsSecretsVersionsEnableCall added in v0.162.0 

type ProjectsLocationsSecretsVersionsEnableCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsVersionsEnableCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsEnableCall) Context(ctx context.Context) *ProjectsLocationsSecretsVersionsEnableCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsVersionsEnableCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsEnableCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.locations.secrets.versions.enable" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsEnableCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsEnableCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsVersionsEnableCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsVersionsEnableCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsEnableCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsSecretsVersionsGetCall added in v0.162.0 

type ProjectsLocationsSecretsVersionsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsVersionsGetCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsGetCall) Context(ctx context.Context) *ProjectsLocationsSecretsVersionsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsVersionsGetCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsGetCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.locations.secrets.versions.get" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsGetCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsVersionsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsVersionsGetCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsSecretsVersionsGetCall) IfNoneMatch added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsSecretsVersionsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsSecretsVersionsListCall added in v0.162.0 

type ProjectsLocationsSecretsVersionsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsSecretsVersionsListCall) Context added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsListCall) Context(ctx context.Context) *ProjectsLocationsSecretsVersionsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsSecretsVersionsListCall) Do added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsListCall) Do(opts ...googleapi.CallOption) (*ListSecretVersionsResponse, error)

Do executes the "secretmanager.projects.locations.secrets.versions.list" call. Any non-2xx status code is an error. Response headers are in either *ListSecretVersionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsListCall) Fields added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsSecretsVersionsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsSecretsVersionsListCall) Filter added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsListCall) Filter(filter string) *ProjectsLocationsSecretsVersionsListCall

Filter sets the optional parameter "filter": Filter string, adhering to the rules in List-operation filtering (https://cloud.google.com/secret-manager/docs/filtering). List only secret versions matching the filter. If filter is empty, all secret versions are listed.

func (*ProjectsLocationsSecretsVersionsListCall) Header added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsSecretsVersionsListCall) IfNoneMatch added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsSecretsVersionsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsSecretsVersionsListCall) PageSize added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsListCall) PageSize(pageSize int64) *ProjectsLocationsSecretsVersionsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsLocationsSecretsVersionsListCall) PageToken added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsListCall) PageToken(pageToken string) *ProjectsLocationsSecretsVersionsListCall

PageToken sets the optional parameter "pageToken": Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].

func (*ProjectsLocationsSecretsVersionsListCall) Pages added in v0.162.0 

func (c *ProjectsLocationsSecretsVersionsListCall) Pages(ctx context.Context, f func(*ListSecretVersionsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsSecretsVersionsService added in v0.162.0 

type ProjectsLocationsSecretsVersionsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsSecretsVersionsService added in v0.162.0 

func NewProjectsLocationsSecretsVersionsService(s *Service) *ProjectsLocationsSecretsVersionsService

func (*ProjectsLocationsSecretsVersionsService) Access added in v0.162.0 

func (r *ProjectsLocationsSecretsVersionsService) Access(name string) *ProjectsLocationsSecretsVersionsAccessCall

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

  • name: The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.

func (*ProjectsLocationsSecretsVersionsService) Destroy added in v0.162.0 

func (r *ProjectsLocationsSecretsVersionsService) Destroy(name string, destroysecretversionrequest *DestroySecretVersionRequest) *ProjectsLocationsSecretsVersionsDestroyCall

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

  • name: The resource name of the SecretVersion to destroy in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.

func (*ProjectsLocationsSecretsVersionsService) Disable added in v0.162.0 

func (r *ProjectsLocationsSecretsVersionsService) Disable(name string, disablesecretversionrequest *DisableSecretVersionRequest) *ProjectsLocationsSecretsVersionsDisableCall

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

  • name: The resource name of the SecretVersion to disable in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.

func (*ProjectsLocationsSecretsVersionsService) Enable added in v0.162.0 

func (r *ProjectsLocationsSecretsVersionsService) Enable(name string, enablesecretversionrequest *EnableSecretVersionRequest) *ProjectsLocationsSecretsVersionsEnableCall

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

  • name: The resource name of the SecretVersion to enable in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.

func (*ProjectsLocationsSecretsVersionsService) Get added in v0.162.0 

func (r *ProjectsLocationsSecretsVersionsService) Get(name string) *ProjectsLocationsSecretsVersionsGetCall

Get: Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.

  • name: The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.

func (*ProjectsLocationsSecretsVersionsService) List added in v0.162.0 

func (r *ProjectsLocationsSecretsVersionsService) List(parent string) *ProjectsLocationsSecretsVersionsListCall

List: Lists SecretVersions. This call does not return secret data.

  • parent: The resource name of the Secret associated with the SecretVersions to list, in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.

type ProjectsLocationsService 

type ProjectsLocationsService struct {
	Secrets *ProjectsLocationsSecretsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService 

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get 

func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List 

func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall

List: Lists information about the supported locations for this service.

- name: The resource that owns the locations collection, if applicable.

type ProjectsSecretsAddVersionCall 

type ProjectsSecretsAddVersionCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsAddVersionCall) Context 

func (c *ProjectsSecretsAddVersionCall) Context(ctx context.Context) *ProjectsSecretsAddVersionCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsAddVersionCall) Do 

func (c *ProjectsSecretsAddVersionCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.secrets.addVersion" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsAddVersionCall) Fields 

func (c *ProjectsSecretsAddVersionCall) Fields(s ...googleapi.Field) *ProjectsSecretsAddVersionCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsAddVersionCall) Header 

func (c *ProjectsSecretsAddVersionCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsSecretsCreateCall 

type ProjectsSecretsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsCreateCall) Context 

func (c *ProjectsSecretsCreateCall) Context(ctx context.Context) *ProjectsSecretsCreateCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsCreateCall) Do 

func (c *ProjectsSecretsCreateCall) Do(opts ...googleapi.CallOption) (*Secret, error)

Do executes the "secretmanager.projects.secrets.create" call. Any non-2xx status code is an error. Response headers are in either *Secret.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsCreateCall) Fields 

func (c *ProjectsSecretsCreateCall) Fields(s ...googleapi.Field) *ProjectsSecretsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsCreateCall) Header 

func (c *ProjectsSecretsCreateCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSecretsCreateCall) SecretId 

func (c *ProjectsSecretsCreateCall) SecretId(secretId string) *ProjectsSecretsCreateCall

SecretId sets the optional parameter "secretId": 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.

type ProjectsSecretsDeleteCall 

type ProjectsSecretsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsDeleteCall) Context 

func (c *ProjectsSecretsDeleteCall) Context(ctx context.Context) *ProjectsSecretsDeleteCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsDeleteCall) Do 

func (c *ProjectsSecretsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "secretmanager.projects.secrets.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsDeleteCall) Etag added in v0.47.0 

func (c *ProjectsSecretsDeleteCall) Etag(etag string) *ProjectsSecretsDeleteCall

Etag sets the optional parameter "etag": Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds.

func (*ProjectsSecretsDeleteCall) Fields 

func (c *ProjectsSecretsDeleteCall) Fields(s ...googleapi.Field) *ProjectsSecretsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsDeleteCall) Header 

func (c *ProjectsSecretsDeleteCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsSecretsGetCall 

type ProjectsSecretsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsGetCall) Context 

func (c *ProjectsSecretsGetCall) Context(ctx context.Context) *ProjectsSecretsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsGetCall) Do 

func (c *ProjectsSecretsGetCall) Do(opts ...googleapi.CallOption) (*Secret, error)

Do executes the "secretmanager.projects.secrets.get" call. Any non-2xx status code is an error. Response headers are in either *Secret.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsGetCall) Fields 

func (c *ProjectsSecretsGetCall) Fields(s ...googleapi.Field) *ProjectsSecretsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsGetCall) Header 

func (c *ProjectsSecretsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSecretsGetCall) IfNoneMatch 

func (c *ProjectsSecretsGetCall) IfNoneMatch(entityTag string) *ProjectsSecretsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsSecretsGetIamPolicyCall 

type ProjectsSecretsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsGetIamPolicyCall) Context 

func (c *ProjectsSecretsGetIamPolicyCall) Context(ctx context.Context) *ProjectsSecretsGetIamPolicyCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsGetIamPolicyCall) Do 

func (c *ProjectsSecretsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "secretmanager.projects.secrets.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsGetIamPolicyCall) Fields 

func (c *ProjectsSecretsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSecretsGetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsGetIamPolicyCall) Header 

func (c *ProjectsSecretsGetIamPolicyCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSecretsGetIamPolicyCall) IfNoneMatch 

func (c *ProjectsSecretsGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsSecretsGetIamPolicyCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsSecretsGetIamPolicyCall) OptionsRequestedPolicyVersion 

func (c *ProjectsSecretsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsSecretsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": 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 (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsSecretsListCall 

type ProjectsSecretsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsListCall) Context 

func (c *ProjectsSecretsListCall) Context(ctx context.Context) *ProjectsSecretsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsListCall) Do 

func (c *ProjectsSecretsListCall) Do(opts ...googleapi.CallOption) (*ListSecretsResponse, error)

Do executes the "secretmanager.projects.secrets.list" call. Any non-2xx status code is an error. Response headers are in either *ListSecretsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsListCall) Fields 

func (c *ProjectsSecretsListCall) Fields(s ...googleapi.Field) *ProjectsSecretsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsListCall) Filter added in v0.51.0 

func (c *ProjectsSecretsListCall) Filter(filter string) *ProjectsSecretsListCall

Filter sets the optional parameter "filter": Filter string, adhering to the rules in List-operation filtering (https://cloud.google.com/secret-manager/docs/filtering). List only secrets matching the filter. If filter is empty, all secrets are listed.

func (*ProjectsSecretsListCall) Header 

func (c *ProjectsSecretsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSecretsListCall) IfNoneMatch 

func (c *ProjectsSecretsListCall) IfNoneMatch(entityTag string) *ProjectsSecretsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsSecretsListCall) PageSize 

func (c *ProjectsSecretsListCall) PageSize(pageSize int64) *ProjectsSecretsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsSecretsListCall) PageToken 

func (c *ProjectsSecretsListCall) PageToken(pageToken string) *ProjectsSecretsListCall

PageToken sets the optional parameter "pageToken": Pagination token, returned earlier via ListSecretsResponse.next_page_token.

func (*ProjectsSecretsListCall) Pages 

func (c *ProjectsSecretsListCall) Pages(ctx context.Context, f func(*ListSecretsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsSecretsPatchCall 

type ProjectsSecretsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsPatchCall) Context 

func (c *ProjectsSecretsPatchCall) Context(ctx context.Context) *ProjectsSecretsPatchCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsPatchCall) Do 

func (c *ProjectsSecretsPatchCall) Do(opts ...googleapi.CallOption) (*Secret, error)

Do executes the "secretmanager.projects.secrets.patch" call. Any non-2xx status code is an error. Response headers are in either *Secret.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsPatchCall) Fields 

func (c *ProjectsSecretsPatchCall) Fields(s ...googleapi.Field) *ProjectsSecretsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsPatchCall) Header 

func (c *ProjectsSecretsPatchCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSecretsPatchCall) UpdateMask 

func (c *ProjectsSecretsPatchCall) UpdateMask(updateMask string) *ProjectsSecretsPatchCall

UpdateMask sets the optional parameter "updateMask": Required. Specifies the fields to be updated.

type ProjectsSecretsService 

type ProjectsSecretsService struct {
	Versions *ProjectsSecretsVersionsService
	// contains filtered or unexported fields
}

func NewProjectsSecretsService 

func NewProjectsSecretsService(s *Service) *ProjectsSecretsService

func (*ProjectsSecretsService) AddVersion 

func (r *ProjectsSecretsService) AddVersion(parent string, addsecretversionrequest *AddSecretVersionRequest) *ProjectsSecretsAddVersionCall

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

  • parent: The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.

func (*ProjectsSecretsService) Create 

func (r *ProjectsSecretsService) Create(parent string, secret *Secret) *ProjectsSecretsCreateCall

Create: Creates a new Secret containing no SecretVersions.

  • parent: The resource name of the project to associate with the Secret, in the format `projects/*` or `projects/*/locations/*`.

func (*ProjectsSecretsService) Delete 

func (r *ProjectsSecretsService) Delete(name string) *ProjectsSecretsDeleteCall

Delete: Deletes a Secret.

  • name: The resource name of the Secret to delete in the format `projects/*/secrets/*`.

func (*ProjectsSecretsService) Get 

func (r *ProjectsSecretsService) Get(name string) *ProjectsSecretsGetCall

Get: Gets metadata for a given Secret.

  • name: The resource name of the Secret, in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.

func (*ProjectsSecretsService) GetIamPolicy 

func (r *ProjectsSecretsService) GetIamPolicy(resource string) *ProjectsSecretsGetIamPolicyCall

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

func (*ProjectsSecretsService) List 

func (r *ProjectsSecretsService) List(parent string) *ProjectsSecretsListCall

List: Lists Secrets.

  • parent: The resource name of the project associated with the Secrets, in the format `projects/*` or `projects/*/locations/*`.

func (*ProjectsSecretsService) Patch 

func (r *ProjectsSecretsService) Patch(name string, secret *Secret) *ProjectsSecretsPatchCall

Patch: Updates metadata of an existing Secret.

  • name: Output only. The resource name of the Secret in the format `projects/*/secrets/*`.

func (*ProjectsSecretsService) SetIamPolicy 

func (r *ProjectsSecretsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSecretsSetIamPolicyCall

SetIamPolicy: 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.

func (*ProjectsSecretsService) TestIamPermissions 

func (r *ProjectsSecretsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsSecretsTestIamPermissionsCall

TestIamPermissions: 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.

type ProjectsSecretsSetIamPolicyCall 

type ProjectsSecretsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsSetIamPolicyCall) Context 

func (c *ProjectsSecretsSetIamPolicyCall) Context(ctx context.Context) *ProjectsSecretsSetIamPolicyCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsSetIamPolicyCall) Do 

func (c *ProjectsSecretsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "secretmanager.projects.secrets.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsSetIamPolicyCall) Fields 

func (c *ProjectsSecretsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSecretsSetIamPolicyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsSetIamPolicyCall) Header 

func (c *ProjectsSecretsSetIamPolicyCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsSecretsTestIamPermissionsCall 

type ProjectsSecretsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsTestIamPermissionsCall) Context 

func (c *ProjectsSecretsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsSecretsTestIamPermissionsCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsTestIamPermissionsCall) Do 

func (c *ProjectsSecretsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "secretmanager.projects.secrets.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsTestIamPermissionsCall) Fields 

func (c *ProjectsSecretsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsSecretsTestIamPermissionsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsTestIamPermissionsCall) Header 

func (c *ProjectsSecretsTestIamPermissionsCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsSecretsVersionsAccessCall 

type ProjectsSecretsVersionsAccessCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsVersionsAccessCall) Context 

func (c *ProjectsSecretsVersionsAccessCall) Context(ctx context.Context) *ProjectsSecretsVersionsAccessCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsVersionsAccessCall) Do 

func (c *ProjectsSecretsVersionsAccessCall) Do(opts ...googleapi.CallOption) (*AccessSecretVersionResponse, error)

Do executes the "secretmanager.projects.secrets.versions.access" call. Any non-2xx status code is an error. Response headers are in either *AccessSecretVersionResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsAccessCall) Fields 

func (c *ProjectsSecretsVersionsAccessCall) Fields(s ...googleapi.Field) *ProjectsSecretsVersionsAccessCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsVersionsAccessCall) Header 

func (c *ProjectsSecretsVersionsAccessCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSecretsVersionsAccessCall) IfNoneMatch 

func (c *ProjectsSecretsVersionsAccessCall) IfNoneMatch(entityTag string) *ProjectsSecretsVersionsAccessCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsSecretsVersionsDestroyCall 

type ProjectsSecretsVersionsDestroyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsVersionsDestroyCall) Context 

func (c *ProjectsSecretsVersionsDestroyCall) Context(ctx context.Context) *ProjectsSecretsVersionsDestroyCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsVersionsDestroyCall) Do 

func (c *ProjectsSecretsVersionsDestroyCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.secrets.versions.destroy" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsDestroyCall) Fields 

func (c *ProjectsSecretsVersionsDestroyCall) Fields(s ...googleapi.Field) *ProjectsSecretsVersionsDestroyCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsVersionsDestroyCall) Header 

func (c *ProjectsSecretsVersionsDestroyCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsSecretsVersionsDisableCall 

type ProjectsSecretsVersionsDisableCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsVersionsDisableCall) Context 

func (c *ProjectsSecretsVersionsDisableCall) Context(ctx context.Context) *ProjectsSecretsVersionsDisableCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsVersionsDisableCall) Do 

func (c *ProjectsSecretsVersionsDisableCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.secrets.versions.disable" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsDisableCall) Fields 

func (c *ProjectsSecretsVersionsDisableCall) Fields(s ...googleapi.Field) *ProjectsSecretsVersionsDisableCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsVersionsDisableCall) Header 

func (c *ProjectsSecretsVersionsDisableCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsSecretsVersionsEnableCall 

type ProjectsSecretsVersionsEnableCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsVersionsEnableCall) Context 

func (c *ProjectsSecretsVersionsEnableCall) Context(ctx context.Context) *ProjectsSecretsVersionsEnableCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsVersionsEnableCall) Do 

func (c *ProjectsSecretsVersionsEnableCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.secrets.versions.enable" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsEnableCall) Fields 

func (c *ProjectsSecretsVersionsEnableCall) Fields(s ...googleapi.Field) *ProjectsSecretsVersionsEnableCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsVersionsEnableCall) Header 

func (c *ProjectsSecretsVersionsEnableCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsSecretsVersionsGetCall 

type ProjectsSecretsVersionsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsVersionsGetCall) Context 

func (c *ProjectsSecretsVersionsGetCall) Context(ctx context.Context) *ProjectsSecretsVersionsGetCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsVersionsGetCall) Do 

func (c *ProjectsSecretsVersionsGetCall) Do(opts ...googleapi.CallOption) (*SecretVersion, error)

Do executes the "secretmanager.projects.secrets.versions.get" call. Any non-2xx status code is an error. Response headers are in either *SecretVersion.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsGetCall) Fields 

func (c *ProjectsSecretsVersionsGetCall) Fields(s ...googleapi.Field) *ProjectsSecretsVersionsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsVersionsGetCall) Header 

func (c *ProjectsSecretsVersionsGetCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSecretsVersionsGetCall) IfNoneMatch 

func (c *ProjectsSecretsVersionsGetCall) IfNoneMatch(entityTag string) *ProjectsSecretsVersionsGetCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsSecretsVersionsListCall 

type ProjectsSecretsVersionsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsSecretsVersionsListCall) Context 

func (c *ProjectsSecretsVersionsListCall) Context(ctx context.Context) *ProjectsSecretsVersionsListCall

Context sets the context to be used in this call's Do method.

func (*ProjectsSecretsVersionsListCall) Do 

func (c *ProjectsSecretsVersionsListCall) Do(opts ...googleapi.CallOption) (*ListSecretVersionsResponse, error)

Do executes the "secretmanager.projects.secrets.versions.list" call. Any non-2xx status code is an error. Response headers are in either *ListSecretVersionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsListCall) Fields 

func (c *ProjectsSecretsVersionsListCall) Fields(s ...googleapi.Field) *ProjectsSecretsVersionsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsSecretsVersionsListCall) Filter added in v0.51.0 

func (c *ProjectsSecretsVersionsListCall) Filter(filter string) *ProjectsSecretsVersionsListCall

Filter sets the optional parameter "filter": Filter string, adhering to the rules in List-operation filtering (https://cloud.google.com/secret-manager/docs/filtering). List only secret versions matching the filter. If filter is empty, all secret versions are listed.

func (*ProjectsSecretsVersionsListCall) Header 

func (c *ProjectsSecretsVersionsListCall) Header() http.Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsSecretsVersionsListCall) IfNoneMatch 

func (c *ProjectsSecretsVersionsListCall) IfNoneMatch(entityTag string) *ProjectsSecretsVersionsListCall

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsSecretsVersionsListCall) PageSize 

func (c *ProjectsSecretsVersionsListCall) PageSize(pageSize int64) *ProjectsSecretsVersionsListCall

PageSize sets the optional parameter "pageSize": 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.

func (*ProjectsSecretsVersionsListCall) PageToken 

func (c *ProjectsSecretsVersionsListCall) PageToken(pageToken string) *ProjectsSecretsVersionsListCall

PageToken sets the optional parameter "pageToken": Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][].

func (*ProjectsSecretsVersionsListCall) Pages 

func (c *ProjectsSecretsVersionsListCall) Pages(ctx context.Context, f func(*ListSecretVersionsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsSecretsVersionsService 

type ProjectsSecretsVersionsService struct {
	// contains filtered or unexported fields
}

func NewProjectsSecretsVersionsService 

func NewProjectsSecretsVersionsService(s *Service) *ProjectsSecretsVersionsService

func (*ProjectsSecretsVersionsService) Access 

func (r *ProjectsSecretsVersionsService) Access(name string) *ProjectsSecretsVersionsAccessCall

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

  • name: The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.

func (*ProjectsSecretsVersionsService) Destroy 

func (r *ProjectsSecretsVersionsService) Destroy(name string, destroysecretversionrequest *DestroySecretVersionRequest) *ProjectsSecretsVersionsDestroyCall

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

  • name: The resource name of the SecretVersion to destroy in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.

func (*ProjectsSecretsVersionsService) Disable 

func (r *ProjectsSecretsVersionsService) Disable(name string, disablesecretversionrequest *DisableSecretVersionRequest) *ProjectsSecretsVersionsDisableCall

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

  • name: The resource name of the SecretVersion to disable in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.

func (*ProjectsSecretsVersionsService) Enable 

func (r *ProjectsSecretsVersionsService) Enable(name string, enablesecretversionrequest *EnableSecretVersionRequest) *ProjectsSecretsVersionsEnableCall

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

  • name: The resource name of the SecretVersion to enable in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`.

func (*ProjectsSecretsVersionsService) Get 

func (r *ProjectsSecretsVersionsService) Get(name string) *ProjectsSecretsVersionsGetCall

Get: Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.

  • name: The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` or `projects/*/locations/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.

func (*ProjectsSecretsVersionsService) List 

func (r *ProjectsSecretsVersionsService) List(parent string) *ProjectsSecretsVersionsListCall

List: Lists SecretVersions. This call does not return secret data.

  • parent: The resource name of the Secret associated with the SecretVersions to list, in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.

type ProjectsService 

type ProjectsService struct {
	Locations *ProjectsLocationsService

	Secrets *ProjectsSecretsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type Replica 

type Replica struct {
	// CustomerManagedEncryption: Optional. The customer-managed encryption
	// configuration of the User-Managed Replica. If no configuration is provided,
	// Google-managed default encryption is used. Updates to the Secret encryption
	// configuration only apply to SecretVersions added afterwards. They do not
	// apply retroactively to existing SecretVersions.
	CustomerManagedEncryption *CustomerManagedEncryption `json:"customerManagedEncryption,omitempty"`
	// Location: The canonical IDs of the location to replicate data. For example:
	// "us-east1".
	Location string `json:"location,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomerManagedEncryption")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CustomerManagedEncryption") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Replica: Represents a Replica for this Secret.

func (Replica) MarshalJSON 

func (s Replica) MarshalJSON() ([]byte, error)

type ReplicaStatus added in v0.32.0 

type ReplicaStatus struct {
	// CustomerManagedEncryption: Output only. The customer-managed encryption
	// status of the SecretVersion. Only populated if customer-managed encryption
	// is used.
	CustomerManagedEncryption *CustomerManagedEncryptionStatus `json:"customerManagedEncryption,omitempty"`
	// Location: Output only. The canonical ID of the replica location. For
	// example: "us-east1".
	Location string `json:"location,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomerManagedEncryption")
	// to unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "CustomerManagedEncryption") to
	// include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReplicaStatus: Describes the status of a user-managed replica for the SecretVersion.

func (ReplicaStatus) MarshalJSON added in v0.32.0 

func (s ReplicaStatus) MarshalJSON() ([]byte, error)

type Replication 

type Replication struct {
	// Automatic: The Secret will automatically be replicated without any
	// restrictions.
	Automatic *Automatic `json:"automatic,omitempty"`
	// UserManaged: The Secret will only be replicated into the locations
	// specified.
	UserManaged *UserManaged `json:"userManaged,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Automatic") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Automatic") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Replication: A policy that defines the replication and encryption configuration of data.

func (Replication) MarshalJSON 

func (s Replication) MarshalJSON() ([]byte, error)

type ReplicationStatus added in v0.32.0 

type ReplicationStatus struct {
	// Automatic: Describes the replication status of a SecretVersion with
	// automatic replication. Only populated if the parent Secret has an automatic
	// replication policy.
	Automatic *AutomaticStatus `json:"automatic,omitempty"`
	// UserManaged: Describes the replication status of a SecretVersion with
	// user-managed replication. Only populated if the parent Secret has a
	// user-managed replication policy.
	UserManaged *UserManagedStatus `json:"userManaged,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Automatic") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Automatic") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

ReplicationStatus: The replication status of a SecretVersion.

func (ReplicationStatus) MarshalJSON added in v0.32.0 

func (s ReplicationStatus) MarshalJSON() ([]byte, error)

type Rotation added in v0.44.0 

type Rotation struct {
	// NextRotationTime: Optional. Timestamp in UTC at which the Secret is
	// scheduled to rotate. Cannot be set to less than 300s (5 min) in the future
	// and at most 3153600000s (100 years). next_rotation_time MUST be set if
	// rotation_period is set.
	NextRotationTime string `json:"nextRotationTime,omitempty"`
	// RotationPeriod: Input only. The Duration between rotation notifications.
	// Must be in seconds and at least 3600s (1h) and at most 3153600000s (100
	// years). If rotation_period is set, next_rotation_time must be set.
	// next_rotation_time will be advanced by this period when the service
	// automatically sends rotation notifications.
	RotationPeriod string `json:"rotationPeriod,omitempty"`
	// ForceSendFields is a list of field names (e.g. "NextRotationTime") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "NextRotationTime") to include in
	// API requests with the JSON null value. By default, fields with empty values
	// are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Rotation: The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation.

func (Rotation) MarshalJSON added in v0.44.0 

func (s Rotation) MarshalJSON() ([]byte, error)

type Secret 

type Secret struct {
	// Annotations: Optional. Custom metadata about the secret. Annotations are
	// distinct from various forms of labels. Annotations exist to allow client
	// tools to store their own state information without requiring a database.
	// Annotation keys must be between 1 and 63 characters long, have a UTF-8
	// encoding of maximum 128 bytes, begin and end with an alphanumeric character
	// ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and
	// alphanumerics in between these symbols. The total size of annotation keys
	// and values must be less than 16KiB.
	Annotations map[string]string `json:"annotations,omitempty"`
	// CreateTime: Output only. The time at which the Secret was created.
	CreateTime string `json:"createTime,omitempty"`
	// CustomerManagedEncryption: Optional. The customer-managed encryption
	// configuration of the regionalized secrets. If no configuration is provided,
	// Google-managed default encryption is used. Updates to the Secret encryption
	// configuration only apply to SecretVersions added afterwards. They do not
	// apply retroactively to existing SecretVersions.
	CustomerManagedEncryption *CustomerManagedEncryption `json:"customerManagedEncryption,omitempty"`
	// Etag: Optional. Etag of the currently stored Secret.
	Etag string `json:"etag,omitempty"`
	// ExpireTime: Optional. Timestamp in UTC when the Secret is scheduled to
	// expire. This is always provided on output, regardless of what was sent on
	// input.
	ExpireTime string `json:"expireTime,omitempty"`
	// Labels: The labels assigned to this Secret. Label keys must be between 1 and
	// 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must
	// conform to the following PCRE regular expression: `\p{Ll}\p{Lo}{0,62}` Label
	// values must be between 0 and 63 characters long, have a UTF-8 encoding of
	// maximum 128 bytes, and must conform to the following PCRE regular
	// expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}` No more than 64 labels can be
	// assigned to a given resource.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Output only. The resource name of the Secret in the format
	// `projects/*/secrets/*`.
	Name string `json:"name,omitempty"`
	// Replication: Optional. Immutable. The replication policy of the secret data
	// attached to the Secret. The replication policy cannot be changed after the
	// Secret has been created.
	Replication *Replication `json:"replication,omitempty"`
	// Rotation: Optional. Rotation policy attached to the Secret. May be excluded
	// if there is no rotation policy.
	Rotation *Rotation `json:"rotation,omitempty"`
	// Topics: Optional. A list of up to 10 Pub/Sub topics to which messages are
	// published when control plane operations are called on the secret or its
	// versions.
	Topics []*Topic `json:"topics,omitempty"`
	// Ttl: Input only. The TTL for the Secret.
	Ttl string `json:"ttl,omitempty"`
	// VersionAliases: Optional. Mapping from version alias to version name. A
	// version alias is a string with a maximum length of 63 characters and can
	// contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and
	// underscore ('_') characters. An alias string must start with a letter and
	// cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be
	// assigned to a given secret. Version-Alias pairs will be viewable via
	// GetSecret and modifiable via UpdateSecret. Access by alias is only be
	// supported on GetSecretVersion and AccessSecretVersion.
	VersionAliases map[string]string `json:"versionAliases,omitempty"`
	// VersionDestroyTtl: Optional. Secret Version TTL after destruction request
	// This is a part of the Delayed secret version destroy feature. For secret
	// with TTL>0, version destruction doesn't happen immediately on calling
	// destroy instead the version goes to a disabled state and destruction happens
	// after the TTL expires.
	VersionDestroyTtl string `json:"versionDestroyTtl,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Annotations") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Annotations") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Secret: A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data.

func (Secret) MarshalJSON 

func (s Secret) MarshalJSON() ([]byte, error)

type SecretPayload 

type SecretPayload struct {
	// Data: The secret data. Must be no larger than 64KiB.
	Data string `json:"data,omitempty"`
	// DataCrc32c: Optional. If specified, SecretManagerService will verify the
	// integrity of the received data on SecretManagerService.AddSecretVersion
	// calls using the crc32c checksum and store it to include in future
	// SecretManagerService.AccessSecretVersion responses. If a checksum is not
	// provided in the SecretManagerService.AddSecretVersion request, the
	// SecretManagerService will generate and store one for you. The CRC32C value
	// is encoded as a Int64 for compatibility, and can be safely downconverted to
	// uint32 in languages that support this type.
	// https://cloud.google.com/apis/design/design_patterns#integer_types
	DataCrc32c int64 `json:"dataCrc32c,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "Data") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Data") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SecretPayload: A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion.

func (SecretPayload) MarshalJSON 

func (s SecretPayload) MarshalJSON() ([]byte, error)

type SecretVersion 

type SecretVersion struct {
	// ClientSpecifiedPayloadChecksum: Output only. True if payload checksum
	// specified in SecretPayload object has been received by SecretManagerService
	// on SecretManagerService.AddSecretVersion.
	ClientSpecifiedPayloadChecksum bool `json:"clientSpecifiedPayloadChecksum,omitempty"`
	// CreateTime: Output only. The time at which the SecretVersion was created.
	CreateTime string `json:"createTime,omitempty"`
	// CustomerManagedEncryption: Output only. The customer-managed encryption
	// status of the SecretVersion. Only populated if customer-managed encryption
	// is used and Secret is a regionalized secret.
	CustomerManagedEncryption *CustomerManagedEncryptionStatus `json:"customerManagedEncryption,omitempty"`
	// DestroyTime: Output only. The time this SecretVersion was destroyed. Only
	// present if state is DESTROYED.
	DestroyTime string `json:"destroyTime,omitempty"`
	// Etag: Output only. Etag of the currently stored SecretVersion.
	Etag string `json:"etag,omitempty"`
	// Name: 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.
	Name string `json:"name,omitempty"`
	// ReplicationStatus: The replication status of the SecretVersion.
	ReplicationStatus *ReplicationStatus `json:"replicationStatus,omitempty"`
	// ScheduledDestroyTime: Optional. Output only. Scheduled destroy time for
	// secret version. This is a part of the Delayed secret version destroy
	// feature. For a Secret with a valid version destroy TTL, when a secert
	// version is destroyed, version is moved to disabled state and it is scheduled
	// for destruction Version is destroyed only after the scheduled_destroy_time.
	ScheduledDestroyTime string `json:"scheduledDestroyTime,omitempty"`
	// State: Output only. The current state of the SecretVersion.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Not specified. This value is unused and invalid.
	//   "ENABLED" - The SecretVersion may be accessed.
	//   "DISABLED" - The SecretVersion may not be accessed, but the secret data is
	// still available and can be placed back into the ENABLED state.
	//   "DESTROYED" - The SecretVersion is destroyed and the secret data is no
	// longer stored. A version may not leave this state once entered.
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g.
	// "ClientSpecifiedPayloadChecksum") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted from
	// API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "ClientSpecifiedPayloadChecksum")
	// to include in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SecretVersion: A secret version resource in the Secret Manager API.

func (SecretVersion) MarshalJSON 

func (s SecretVersion) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SetIamPolicyRequest 

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the `resource`. The
	// size of the policy is limited to a few 10s of KB. An empty policy is a valid
	// policy but certain Google Cloud services (such as Projects) might reject
	// them.
	Policy *Policy `json:"policy,omitempty"`
	// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the policy to
	// modify. Only the fields in the mask will be modified. If no mask is
	// provided, the following default mask is used: `paths: "bindings, etag"
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Policy") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Policy") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest) MarshalJSON 

func (s SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest 

type TestIamPermissionsRequest struct {
	// Permissions: The set of permissions to check for the `resource`. Permissions
	// with wildcards (such as `*` or `storage.*`) are not allowed. For more
	// information see IAM Overview
	// (https://cloud.google.com/iam/docs/overview#permissions).
	Permissions []string `json:"permissions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest) MarshalJSON 

func (s TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse 

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that the
	// caller is allowed.
	Permissions []string `json:"permissions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Permissions") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (TestIamPermissionsResponse) MarshalJSON 

func (s TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

type Topic added in v0.40.0 

type Topic struct {
	// Name: Identifier. The resource name of the Pub/Sub topic that will be
	// published to, in the following format: `projects/*/topics/*`. For
	// publication to succeed, the Secret Manager service agent must have the
	// `pubsub.topic.publish` permission on the topic. The Pub/Sub Publisher role
	// (`roles/pubsub.publisher`) includes this permission.
	Name string `json:"name,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
	// include in API requests. By default, fields with empty or default values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Name") to include in API requests
	// with the JSON null value. By default, fields with empty values are omitted
	// from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

Topic: A Pub/Sub topic which Secret Manager will publish to when control plane events occur on this secret.

func (Topic) MarshalJSON added in v0.40.0 

func (s Topic) MarshalJSON() ([]byte, error)

type UserManaged 

type UserManaged struct {
	// Replicas: Required. The list of Replicas for this Secret. Cannot be empty.
	Replicas []*Replica `json:"replicas,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Replicas") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Replicas") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UserManaged: A replication policy that replicates the Secret payload into the locations specified in Replication.UserManaged.replicas

func (UserManaged) MarshalJSON 

func (s UserManaged) MarshalJSON() ([]byte, error)

type UserManagedStatus added in v0.32.0 

type UserManagedStatus struct {
	// Replicas: Output only. The list of replica statuses for the SecretVersion.
	Replicas []*ReplicaStatus `json:"replicas,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Replicas") to
	// unconditionally include in API requests. By default, fields with empty or
	// default values are omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
	// details.
	ForceSendFields []string `json:"-"`
	// NullFields is a list of field names (e.g. "Replicas") to include in API
	// requests with the JSON null value. By default, fields with empty values are
	// omitted from API requests. See
	// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
	NullFields []string `json:"-"`
}

UserManagedStatus: The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy.

func (UserManagedStatus) MarshalJSON added in v0.32.0 

func (s UserManagedStatus) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.