Movatterモバイル変換


[0]ホーム

URL:


secretmanager

package
v0.257.0Latest Latest
Warning

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

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:13

Details

Repository

github.com/googleapis/google-api-go-client

Links

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, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany 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 forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.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 OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

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

Seegoogle.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

typeAccessSecretVersionResponse

type AccessSecretVersionResponse struct {// Name: The resource name of the SecretVersion in the format// `projects/*/secrets/*/versions/*` or// `projects/*/locations/*/secrets/*/versions/*`.Namestring `json:"name,omitempty"`// Payload: Secret payloadPayload *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 forSecretManagerService.AccessSecretVersion.

func (AccessSecretVersionResponse)MarshalJSON

func (sAccessSecretVersionResponse) MarshalJSON() ([]byte,error)

typeAddSecretVersionRequest

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 forSecretManagerService.AddSecretVersion.

func (AddSecretVersionRequest)MarshalJSON

func (sAddSecretVersionRequest) MarshalJSON() ([]byte,error)

typeAuditConfig

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.Servicestring `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. Theconfiguration determines which permission types are logged, and whatidentities, if any, are exempted from logging. An AuditConfig must have oneor more AuditLogConfigs. If there are AuditConfigs for both `allServices`and a specific service, the union of the two AuditConfigs is used for thatservice: the log_types specified in each AuditConfig are enabled, and theexempted_members in each AuditLogConfig are exempted. Example Policy withmultiple 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" ] } ] } ] } Forsampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READlogging. It also exempts `jose@example.com` from DATA_READ logging, and`aliya@example.com` from DATA_WRITE logging.

func (AuditConfig)MarshalJSON

func (sAuditConfig) MarshalJSON() ([]byte,error)

typeAuditLogConfig

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 listLogTypestring `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 ofpermissions. 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, whileexempting jose@example.com from DATA_READ logging.

func (AuditLogConfig)MarshalJSON

func (sAuditLogConfig) MarshalJSON() ([]byte,error)

typeAutomatic

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 withoutany restrictions.

func (Automatic)MarshalJSONadded inv0.32.0

func (sAutomatic) MarshalJSON() ([]byte,error)

typeAutomaticStatusadded inv0.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 automaticreplication. Only populated if the parent Secret has an automaticreplication policy.

func (AutomaticStatus)MarshalJSONadded inv0.32.0

func (sAutomaticStatus) MarshalJSON() ([]byte,error)

typeBinding

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).Rolestring `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 (sBinding) MarshalJSON() ([]byte,error)

typeCustomerManagedEncryptionadded inv0.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/*`.KmsKeyNamestring `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 payloadsusing customer-managed encryption keys (CMEK).

func (CustomerManagedEncryption)MarshalJSONadded inv0.32.0

func (sCustomerManagedEncryption) MarshalJSON() ([]byte,error)

typeCustomerManagedEncryptionStatusadded inv0.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/*`.KmsKeyVersionNamestring `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-managedencryption.

func (CustomerManagedEncryptionStatus)MarshalJSONadded inv0.32.0

func (sCustomerManagedEncryptionStatus) MarshalJSON() ([]byte,error)

typeDestroySecretVersionRequest

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.Etagstring `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 forSecretManagerService.DestroySecretVersion.

func (DestroySecretVersionRequest)MarshalJSONadded inv0.47.0

func (sDestroySecretVersionRequest) MarshalJSON() ([]byte,error)

typeDisableSecretVersionRequest

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.Etagstring `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 forSecretManagerService.DisableSecretVersion.

func (DisableSecretVersionRequest)MarshalJSONadded inv0.47.0

func (sDisableSecretVersionRequest) MarshalJSON() ([]byte,error)

typeEmpty

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 definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeEnableSecretVersionRequest

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.Etagstring `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 forSecretManagerService.EnableSecretVersion.

func (EnableSecretVersionRequest)MarshalJSONadded inv0.47.0

func (sEnableSecretVersionRequest) MarshalJSON() ([]byte,error)

typeExpr

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.Descriptionstring `json:"description,omitempty"`// Expression: Textual representation of an expression in Common Expression// Language syntax.Expressionstring `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.Locationstring `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.Titlestring `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 semanticsof CEL are documented athttps://github.com/google/cel-spec. Example(Comparison): title: "Summary size limit" description: "Determines if asummary is less than 100 chars" expression: "document.summary.size() < 100"Example (Equality): title: "Requestor is owner" description: "Determines ifrequestor 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 messagereceived at ' + string(document.create_time)" The exact variables andfunctions that may be referenced within an expression are determined by theservice that evaluates it. See the service documentation for additionalinformation.

func (Expr)MarshalJSON

func (sExpr) MarshalJSON() ([]byte,error)

typeListLocationsResponse

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.NextPageTokenstring `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 (sListLocationsResponse) MarshalJSON() ([]byte,error)

typeListSecretVersionsResponse

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.NextPageTokenstring `json:"nextPageToken,omitempty"`// TotalSize: The total number of SecretVersions but 0 when the// ListSecretsRequest.filter field is set.TotalSizeint64 `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 forSecretManagerService.ListSecretVersions.

func (ListSecretVersionsResponse)MarshalJSON

func (sListSecretVersionsResponse) MarshalJSON() ([]byte,error)

typeListSecretsResponse

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.NextPageTokenstring `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.TotalSizeint64 `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 (sListSecretsResponse) MarshalJSON() ([]byte,error)

typeLocation

type Location struct {// DisplayName: The friendly name for this location, typically a nearby city// name. For example, "Tokyo".DisplayNamestring `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".LocationIdstring `json:"locationId,omitempty"`// Metadata: Service-specific metadata. For example the available capacity at// the given location.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: Resource name for the location, which may vary between// implementations. For example:// "projects/example-project/locations/us-east1"Namestring `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 (sLocation) MarshalJSON() ([]byte,error)

typePolicy

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.Etagstring `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).Versionint64 `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 specifiesaccess controls for Google Cloud resources. A `Policy` is a collection of`bindings`. A `binding` binds one or more `members`, or principals, to asingle `role`. Principals can be user accounts, service accounts, Googlegroups, and domains (such as G Suite). A `role` is a named list ofpermissions; each `role` can be an IAM predefined role or a user-createdcustom role. For some types of Google Cloud resources, a `binding` can alsospecify a `condition`, which is a logical expression that allows access to aresource only if the expression evaluates to `true`. A condition can addconstraints based on attributes of the request, the resource, or both. Tolearn which resources support conditions in their IAM policies, see the IAMdocumentation(https://cloud.google.com/iam/help/conditions/resource-policies). **JSONexample:** ``` { "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.comrole: roles/resourcemanager.organizationAdmin - members: -user:eve@example.com role: roles/resourcemanager.organizationViewercondition: title: expirable access description: Does not grant access afterSep 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 (sPolicy) MarshalJSON() ([]byte,error)

typeProjectsLocationsGetCall

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

func (*ProjectsLocationsGetCall)Context

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

func (*ProjectsLocationsGetCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsGetCall)Header

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

func (*ProjectsLocationsGetCall)IfNoneMatch

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

typeProjectsLocationsListCall

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

func (*ProjectsLocationsListCall)Context

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

func (*ProjectsLocationsListCall)Do

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 returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsListCall)ExtraLocationTypesadded inv0.229.0

func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall

ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do notuse this field. It is unsupported and is ignored unless explicitlydocumented otherwise. This is primarily for internal usage.

func (*ProjectsLocationsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsListCall)Filter

Filter sets the optional parameter "filter": A filter to narrow down resultsto 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

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

func (*ProjectsLocationsListCall)IfNoneMatch

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

func (*ProjectsLocationsListCall)PageSize

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

func (*ProjectsLocationsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token receivedfrom the `next_page_token` field in the response. Send that page token toreceive the subsequent page.

func (*ProjectsLocationsListCall)Pages

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.

typeProjectsLocationsSecretsAddVersionCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsAddVersionCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsAddVersionCall)Doadded inv0.162.0

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsAddVersionCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsAddVersionCall)Headeradded inv0.162.0

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

typeProjectsLocationsSecretsCreateCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsCreateCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsCreateCall)Doadded inv0.162.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsCreateCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsCreateCall)Headeradded inv0.162.0

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

func (*ProjectsLocationsSecretsCreateCall)SecretIdadded inv0.162.0

SecretId sets the optional parameter "secretId": Required. This must beunique within the project. A secret ID is a string with a maximum length of255 characters and can contain uppercase and lowercase letters, numerals,and the hyphen (`-`) and underscore (`_`) characters.

typeProjectsLocationsSecretsDeleteCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsDeleteCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsDeleteCall)Doadded inv0.162.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsDeleteCall)Etagadded inv0.162.0

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

func (*ProjectsLocationsSecretsDeleteCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsDeleteCall)Headeradded inv0.162.0

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

typeProjectsLocationsSecretsGetCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsGetCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsGetCall)Doadded inv0.162.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsGetCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsGetCall)Headeradded inv0.162.0

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

func (*ProjectsLocationsSecretsGetCall)IfNoneMatchadded inv0.162.0

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

typeProjectsLocationsSecretsGetIamPolicyCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsGetIamPolicyCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsGetIamPolicyCall)Doadded inv0.162.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsGetIamPolicyCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsGetIamPolicyCall)Headeradded inv0.162.0

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

func (*ProjectsLocationsSecretsGetIamPolicyCall)IfNoneMatchadded inv0.162.0

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

func (*ProjectsLocationsSecretsGetIamPolicyCall)OptionsRequestedPolicyVersionadded inv0.162.0

func (c *ProjectsLocationsSecretsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *ProjectsLocationsSecretsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsLocationsSecretsListCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsListCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsListCall)Doadded inv0.162.0

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsLocationsSecretsListCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsListCall)Filteradded inv0.162.0

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

func (*ProjectsLocationsSecretsListCall)Headeradded inv0.162.0

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

func (*ProjectsLocationsSecretsListCall)IfNoneMatchadded inv0.162.0

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

func (*ProjectsLocationsSecretsListCall)PageSizeadded inv0.162.0

PageSize sets the optional parameter "pageSize": The maximum number ofresults to be returned in a single page. If set to 0, the server decides thenumber of results to return. If the number is greater than 25000, it iscapped at 25000.

func (*ProjectsLocationsSecretsListCall)PageTokenadded inv0.162.0

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

func (*ProjectsLocationsSecretsListCall)Pagesadded inv0.162.0

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.

typeProjectsLocationsSecretsPatchCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsPatchCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsPatchCall)Doadded inv0.162.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsPatchCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsPatchCall)Headeradded inv0.162.0

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

func (*ProjectsLocationsSecretsPatchCall)UpdateMaskadded inv0.162.0

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

typeProjectsLocationsSecretsServiceadded inv0.162.0

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

funcNewProjectsLocationsSecretsServiceadded inv0.162.0

func NewProjectsLocationsSecretsService(s *Service) *ProjectsLocationsSecretsService

func (*ProjectsLocationsSecretsService)AddVersionadded inv0.162.0

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

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

func (*ProjectsLocationsSecretsService)Createadded inv0.162.0

Create: Creates a new Secret containing no SecretVersions.

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

func (*ProjectsLocationsSecretsService)Deleteadded inv0.162.0

Delete: Deletes a Secret.

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

func (*ProjectsLocationsSecretsService)Getadded inv0.162.0

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)GetIamPolicyadded inv0.162.0

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

func (*ProjectsLocationsSecretsService)Listadded inv0.162.0

List: Lists Secrets.

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

func (*ProjectsLocationsSecretsService)Patchadded inv0.162.0

Patch: Updates metadata of an existing Secret.

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

func (*ProjectsLocationsSecretsService)SetIamPolicyadded inv0.162.0

SetIamPolicy: Sets the access control policy on the specified secret.Replaces any existing policy. Permissions on SecretVersions are enforcedaccording to the policy set on the associated Secret.

func (*ProjectsLocationsSecretsService)TestIamPermissionsadded inv0.162.0

TestIamPermissions: Returns permissions that a caller has for the specifiedsecret. If the secret does not exist, this call returns an empty set ofpermissions, not a NOT_FOUND error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsLocationsSecretsSetIamPolicyCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsSetIamPolicyCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsSetIamPolicyCall)Doadded inv0.162.0

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsSetIamPolicyCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsSetIamPolicyCall)Headeradded inv0.162.0

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

typeProjectsLocationsSecretsTestIamPermissionsCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsTestIamPermissionsCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsTestIamPermissionsCall)Doadded inv0.162.0

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSecretsTestIamPermissionsCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsTestIamPermissionsCall)Headeradded inv0.162.0

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

typeProjectsLocationsSecretsVersionsAccessCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsAccessCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsAccessCall)Doadded inv0.162.0

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsAccessCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsVersionsAccessCall)Headeradded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsAccessCall)IfNoneMatchadded inv0.162.0

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

typeProjectsLocationsSecretsVersionsDestroyCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsDestroyCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsDestroyCall)Doadded inv0.162.0

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsDestroyCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsVersionsDestroyCall)Headeradded inv0.162.0

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

typeProjectsLocationsSecretsVersionsDisableCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsDisableCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsDisableCall)Doadded inv0.162.0

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsDisableCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsVersionsDisableCall)Headeradded inv0.162.0

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

typeProjectsLocationsSecretsVersionsEnableCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsEnableCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsEnableCall)Doadded inv0.162.0

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsEnableCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsVersionsEnableCall)Headeradded inv0.162.0

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

typeProjectsLocationsSecretsVersionsGetCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsGetCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsGetCall)Doadded inv0.162.0

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsGetCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsVersionsGetCall)Headeradded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsGetCall)IfNoneMatchadded inv0.162.0

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

typeProjectsLocationsSecretsVersionsListCalladded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsListCall)Contextadded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsListCall)Doadded inv0.162.0

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsLocationsSecretsVersionsListCall)Fieldsadded inv0.162.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsLocationsSecretsVersionsListCall)Filteradded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsListCall)Headeradded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsListCall)IfNoneMatchadded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsListCall)PageSizeadded inv0.162.0

PageSize sets the optional parameter "pageSize": The maximum number ofresults to be returned in a single page. If set to 0, the server decides thenumber of results to return. If the number is greater than 25000, it iscapped at 25000.

func (*ProjectsLocationsSecretsVersionsListCall)PageTokenadded inv0.162.0

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

func (*ProjectsLocationsSecretsVersionsListCall)Pagesadded inv0.162.0

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.

typeProjectsLocationsSecretsVersionsServiceadded inv0.162.0

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

funcNewProjectsLocationsSecretsVersionsServiceadded inv0.162.0

func NewProjectsLocationsSecretsVersionsService(s *Service) *ProjectsLocationsSecretsVersionsService

func (*ProjectsLocationsSecretsVersionsService)Accessadded inv0.162.0

Access: Accesses a SecretVersion. This call returns the secret data.`projects/*/secrets/*/versions/latest` is an alias to the most recentlycreated 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 mostrecently created SecretVersion.

func (*ProjectsLocationsSecretsVersionsService)Destroyadded inv0.162.0

Destroy: Destroys a SecretVersion. Sets the state of the SecretVersion toDESTROYED 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)Disableadded inv0.162.0

Disable: Disables a SecretVersion. Sets the state of the SecretVersion toDISABLED.

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

func (*ProjectsLocationsSecretsVersionsService)Enableadded inv0.162.0

Enable: Enables a SecretVersion. Sets the state of the SecretVersion toENABLED.

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

func (*ProjectsLocationsSecretsVersionsService)Getadded inv0.162.0

Get: Gets metadata for a SecretVersion.`projects/*/secrets/*/versions/latest` is an alias to the most recentlycreated 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 mostrecently created SecretVersion.

func (*ProjectsLocationsSecretsVersionsService)Listadded inv0.162.0

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

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

typeProjectsLocationsService

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

funcNewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService)Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService)List

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

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

typeProjectsSecretsAddVersionCall

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

func (*ProjectsSecretsAddVersionCall)Context

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

func (*ProjectsSecretsAddVersionCall)Do

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsAddVersionCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsAddVersionCall)Header

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

typeProjectsSecretsCreateCall

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

func (*ProjectsSecretsCreateCall)Context

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

func (*ProjectsSecretsCreateCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsCreateCall)Header

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

func (*ProjectsSecretsCreateCall)SecretId

SecretId sets the optional parameter "secretId": Required. This must beunique within the project. A secret ID is a string with a maximum length of255 characters and can contain uppercase and lowercase letters, numerals,and the hyphen (`-`) and underscore (`_`) characters.

typeProjectsSecretsDeleteCall

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

func (*ProjectsSecretsDeleteCall)Context

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

func (*ProjectsSecretsDeleteCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsDeleteCall)Etagadded inv0.47.0

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

func (*ProjectsSecretsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsDeleteCall)Header

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

typeProjectsSecretsGetCall

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

func (*ProjectsSecretsGetCall)Context

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

func (*ProjectsSecretsGetCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsGetCall)Header

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

func (*ProjectsSecretsGetCall)IfNoneMatch

func (c *ProjectsSecretsGetCall) IfNoneMatch(entityTagstring) *ProjectsSecretsGetCall

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

typeProjectsSecretsGetIamPolicyCall

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

func (*ProjectsSecretsGetIamPolicyCall)Context

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

func (*ProjectsSecretsGetIamPolicyCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsGetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsGetIamPolicyCall)Header

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

func (*ProjectsSecretsGetIamPolicyCall)IfNoneMatch

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

func (*ProjectsSecretsGetIamPolicyCall)OptionsRequestedPolicyVersion

func (c *ProjectsSecretsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersionint64) *ProjectsSecretsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter"options.requestedPolicyVersion": The maximum policy version that will beused to format the policy. Valid values are 0, 1, and 3. Requests specifyingan invalid value will be rejected. Requests for policies with anyconditional role bindings must specify version 3. Policies with noconditional role bindings may specify any valid value or leave the fieldunset. The policy in the response might use the policy version that youspecified, or it might use a lower policy version. For example, if youspecify version 3, but the policy has no conditional role bindings, theresponse uses version 1. To learn which resources support conditions intheir IAM policies, see the IAM documentation(https://cloud.google.com/iam/help/conditions/resource-policies).

typeProjectsSecretsListCall

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

func (*ProjectsSecretsListCall)Context

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

func (*ProjectsSecretsListCall)Do

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 atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*ProjectsSecretsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsListCall)Filteradded inv0.51.0

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

func (*ProjectsSecretsListCall)Header

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

func (*ProjectsSecretsListCall)IfNoneMatch

func (c *ProjectsSecretsListCall) IfNoneMatch(entityTagstring) *ProjectsSecretsListCall

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

func (*ProjectsSecretsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to be returned in a single page. If set to 0, the server decides thenumber of results to return. If the number is greater than 25000, it iscapped at 25000.

func (*ProjectsSecretsListCall)PageToken

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

func (*ProjectsSecretsListCall)Pages

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.

typeProjectsSecretsPatchCall

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

func (*ProjectsSecretsPatchCall)Context

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

func (*ProjectsSecretsPatchCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsPatchCall)Header

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

func (*ProjectsSecretsPatchCall)UpdateMask

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

typeProjectsSecretsService

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

funcNewProjectsSecretsService

func NewProjectsSecretsService(s *Service) *ProjectsSecretsService

func (*ProjectsSecretsService)AddVersion

func (r *ProjectsSecretsService) AddVersion(parentstring, addsecretversionrequest *AddSecretVersionRequest) *ProjectsSecretsAddVersionCall

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

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

func (*ProjectsSecretsService)Create

Create: Creates a new Secret containing no SecretVersions.

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

func (*ProjectsSecretsService)Delete

Delete: Deletes a Secret.

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

func (*ProjectsSecretsService)Get

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

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

func (*ProjectsSecretsService)List

List: Lists Secrets.

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

func (*ProjectsSecretsService)Patch

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(resourcestring, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSecretsSetIamPolicyCall

SetIamPolicy: Sets the access control policy on the specified secret.Replaces any existing policy. Permissions on SecretVersions are enforcedaccording to the policy set on the associated Secret.

func (*ProjectsSecretsService)TestIamPermissions

func (r *ProjectsSecretsService) TestIamPermissions(resourcestring, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsSecretsTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has for the specifiedsecret. If the secret does not exist, this call returns an empty set ofpermissions, not a NOT_FOUND error. Note: This operation is designed to beused for building permission-aware UIs and command-line tools, not forauthorization checking. This operation may "fail open" without warning.

typeProjectsSecretsSetIamPolicyCall

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

func (*ProjectsSecretsSetIamPolicyCall)Context

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

func (*ProjectsSecretsSetIamPolicyCall)Do

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) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsSetIamPolicyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsSetIamPolicyCall)Header

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

typeProjectsSecretsTestIamPermissionsCall

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

func (*ProjectsSecretsTestIamPermissionsCall)Context

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

func (*ProjectsSecretsTestIamPermissionsCall)Do

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsSecretsTestIamPermissionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsTestIamPermissionsCall)Header

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

typeProjectsSecretsVersionsAccessCall

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

func (*ProjectsSecretsVersionsAccessCall)Context

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

func (*ProjectsSecretsVersionsAccessCall)Do

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsSecretsVersionsAccessCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsVersionsAccessCall)Header

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

func (*ProjectsSecretsVersionsAccessCall)IfNoneMatch

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

typeProjectsSecretsVersionsDestroyCall

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

func (*ProjectsSecretsVersionsDestroyCall)Context

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

func (*ProjectsSecretsVersionsDestroyCall)Do

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsDestroyCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsVersionsDestroyCall)Header

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

typeProjectsSecretsVersionsDisableCall

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

func (*ProjectsSecretsVersionsDisableCall)Context

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

func (*ProjectsSecretsVersionsDisableCall)Do

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsDisableCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsVersionsDisableCall)Header

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

typeProjectsSecretsVersionsEnableCall

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

func (*ProjectsSecretsVersionsEnableCall)Context

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

func (*ProjectsSecretsVersionsEnableCall)Do

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsEnableCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsVersionsEnableCall)Header

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

typeProjectsSecretsVersionsGetCall

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

func (*ProjectsSecretsVersionsGetCall)Context

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

func (*ProjectsSecretsVersionsGetCall)Do

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 checkwhether the returned error was because http.StatusNotModified was returned.

func (*ProjectsSecretsVersionsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsVersionsGetCall)Header

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

func (*ProjectsSecretsVersionsGetCall)IfNoneMatch

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

typeProjectsSecretsVersionsListCall

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

func (*ProjectsSecretsVersionsListCall)Context

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

func (*ProjectsSecretsVersionsListCall)Do

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 wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*ProjectsSecretsVersionsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*ProjectsSecretsVersionsListCall)Filteradded inv0.51.0

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

func (*ProjectsSecretsVersionsListCall)Header

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

func (*ProjectsSecretsVersionsListCall)IfNoneMatch

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

func (*ProjectsSecretsVersionsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofresults to be returned in a single page. If set to 0, the server decides thenumber of results to return. If the number is greater than 25000, it iscapped at 25000.

func (*ProjectsSecretsVersionsListCall)PageToken

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

func (*ProjectsSecretsVersionsListCall)Pages

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.

typeProjectsSecretsVersionsService

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

funcNewProjectsSecretsVersionsService

func NewProjectsSecretsVersionsService(s *Service) *ProjectsSecretsVersionsService

func (*ProjectsSecretsVersionsService)Access

Access: Accesses a SecretVersion. This call returns the secret data.`projects/*/secrets/*/versions/latest` is an alias to the most recentlycreated 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 mostrecently created SecretVersion.

func (*ProjectsSecretsVersionsService)Destroy

Destroy: Destroys a SecretVersion. Sets the state of the SecretVersion toDESTROYED 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

Disable: Disables a SecretVersion. Sets the state of the SecretVersion toDISABLED.

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

func (*ProjectsSecretsVersionsService)Enable

Enable: Enables a SecretVersion. Sets the state of the SecretVersion toENABLED.

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

func (*ProjectsSecretsVersionsService)Get

Get: Gets metadata for a SecretVersion.`projects/*/secrets/*/versions/latest` is an alias to the most recentlycreated 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 mostrecently created SecretVersion.

func (*ProjectsSecretsVersionsService)List

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

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

typeProjectsService

type ProjectsService struct {Locations *ProjectsLocationsServiceSecrets *ProjectsSecretsService// contains filtered or unexported fields}

funcNewProjectsService

func NewProjectsService(s *Service) *ProjectsService

typeReplica

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".Locationstring `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 (sReplica) MarshalJSON() ([]byte,error)

typeReplicaStatusadded inv0.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".Locationstring `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 theSecretVersion.

func (ReplicaStatus)MarshalJSONadded inv0.32.0

func (sReplicaStatus) MarshalJSON() ([]byte,error)

typeReplication

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 encryptionconfiguration of data.

func (Replication)MarshalJSON

func (sReplication) MarshalJSON() ([]byte,error)

typeReplicationStatusadded inv0.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)MarshalJSONadded inv0.32.0

func (sReplicationStatus) MarshalJSON() ([]byte,error)

typeRotationadded inv0.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.NextRotationTimestring `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.RotationPeriodstring `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 onthe Secret. Secret.topics must be set to configure rotation.

func (Rotation)MarshalJSONadded inv0.44.0

func (sRotation) MarshalJSON() ([]byte,error)

typeSecret

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.CreateTimestring `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.Etagstring `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.ExpireTimestring `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/*`.Namestring `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"`// Tags: Optional. Input only. Immutable. Mapping of Tag keys/values directly// bound to this resource. For example: "123/environment": "production",// "123/costCenter": "marketing" Tags are used to organize and group resources.// Tags can be used to control policy evaluation for the resource.Tags map[string]string `json:"tags,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.Ttlstring `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.VersionDestroyTtlstring `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 beaccessed. A Secret is made up of zero or more SecretVersions that representthe secret data.

func (Secret)MarshalJSON

func (sSecret) MarshalJSON() ([]byte,error)

typeSecretPayload

type SecretPayload struct {// Data: The secret data. Must be no larger than 64KiB.Datastring `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_typesDataCrc32cint64 `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. Thiscontains the sensitive secret payload that is associated with aSecretVersion.

func (SecretPayload)MarshalJSON

func (sSecretPayload) MarshalJSON() ([]byte,error)

typeSecretVersion

type SecretVersion struct {// ClientSpecifiedPayloadChecksum: Output only. True if payload checksum// specified in SecretPayload object has been received by SecretManagerService// on SecretManagerService.AddSecretVersion.ClientSpecifiedPayloadChecksumbool `json:"clientSpecifiedPayloadChecksum,omitempty"`// CreateTime: Output only. The time at which the SecretVersion was created.CreateTimestring `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.DestroyTimestring `json:"destroyTime,omitempty"`// Etag: Output only. Etag of the currently stored SecretVersion.Etagstring `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.Namestring `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.ScheduledDestroyTimestring `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.Statestring `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 (sSecretVersion) MarshalJSON() ([]byte,error)

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentProjects *ProjectsService// contains filtered or unexported fields}

funcNewdeprecated

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.

funcNewService

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

NewService creates a new Service.

typeSetIamPolicyRequest

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"UpdateMaskstring `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 (sSetIamPolicyRequest) MarshalJSON() ([]byte,error)

typeTestIamPermissionsRequest

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 (sTestIamPermissionsRequest) MarshalJSON() ([]byte,error)

typeTestIamPermissionsResponse

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 (sTestIamPermissionsResponse) MarshalJSON() ([]byte,error)

typeTopicadded inv0.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.Namestring `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 controlplane events occur on this secret.

func (Topic)MarshalJSONadded inv0.40.0

func (sTopic) MarshalJSON() ([]byte,error)

typeUserManaged

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 intothe locations specified in Replication.UserManaged.replicas

func (UserManaged)MarshalJSON

func (sUserManaged) MarshalJSON() ([]byte,error)

typeUserManagedStatusadded inv0.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 usinguser-managed replication. Only populated if the parent Secret has auser-managed replication policy.

func (UserManagedStatus)MarshalJSONadded inv0.32.0

func (sUserManagedStatus) MarshalJSON() ([]byte,error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

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

[8]ページ先頭

©2009-2025 Movatter.jp