privateca

package
v0.210.0 Latest Latest
Warning

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

Go to latest
Published: Dec 4, 2024 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

Package privateca provides access to the Certificate Authority API.

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

Library status

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

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

Creating a client

Usage example:

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

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

Other authentication options

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

privatecaService, err := privateca.NewService(ctx, option.WithAPIKey("AIza..."))

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

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

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

Index

Constants

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

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessUrls

type AccessUrls struct {
	// CaCertificateAccessUrl: The URL where this CertificateAuthority's CA
	// certificate is published. This will only be set for CAs that have been
	// activated.
	CaCertificateAccessUrl string `json:"caCertificateAccessUrl,omitempty"`
	// CrlAccessUrls: The URLs where this CertificateAuthority's CRLs are
	// published. This will only be set for CAs that have been activated.
	CrlAccessUrls []string `json:"crlAccessUrls,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CaCertificateAccessUrl") 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. "CaCertificateAccessUrl") 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:"-"`
}

AccessUrls: URLs where a CertificateAuthority will publish content.

func (AccessUrls) MarshalJSON

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

type ActivateCertificateAuthorityRequest

type ActivateCertificateAuthorityRequest struct {
	// PemCaCertificate: Required. The signed CA certificate issued from
	// FetchCertificateAuthorityCsrResponse.pem_csr.
	PemCaCertificate string `json:"pemCaCertificate,omitempty"`
	// RequestId: Optional. An ID to identify requests. Specify a unique request ID
	// so that if you must retry your request, the server will know to ignore the
	// request if it has already been completed. The server will guarantee that for
	// at least 60 minutes since the first request. For example, consider a
	// situation where you make an initial request and the request times out. If
	// you make the request again with the same request ID, the server can check if
	// original operation with the same request ID was received, and if so, will
	// ignore the second request. This prevents clients from accidentally creating
	// duplicate commitments. The request ID must be a valid UUID with the
	// exception that zero UUID is not supported
	// (00000000-0000-0000-0000-000000000000).
	RequestId string `json:"requestId,omitempty"`
	// SubordinateConfig: Required. Must include information about the issuer of
	// 'pem_ca_certificate', and any further issuers until the self-signed CA.
	SubordinateConfig *SubordinateConfig `json:"subordinateConfig,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PemCaCertificate") 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. "PemCaCertificate") 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:"-"`
}

ActivateCertificateAuthorityRequest: Request message for CertificateAuthorityService.ActivateCertificateAuthority.

func (ActivateCertificateAuthorityRequest) MarshalJSON

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

type AllowedKeyType

type AllowedKeyType struct {
	// EllipticCurve: Represents an allowed Elliptic Curve key type.
	EllipticCurve *EcKeyType `json:"ellipticCurve,omitempty"`
	// Rsa: Represents an allowed RSA key type.
	Rsa *RsaKeyType `json:"rsa,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EllipticCurve") 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. "EllipticCurve") 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:"-"`
}

AllowedKeyType: Describes a "type" of key that may be used in a Certificate issued from a CaPool. Note that a single AllowedKeyType may refer to either a fully-qualified key algorithm, such as RSA 4096, or a family of key algorithms, such as any RSA key.

func (AllowedKeyType) MarshalJSON

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

type AuditConfig

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

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

func (AuditConfig) MarshalJSON

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

type AuditLogConfig

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

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

func (AuditLogConfig) MarshalJSON

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

type Binding

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

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

func (Binding) MarshalJSON

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

type CaOptions

type CaOptions struct {
	// IsCa: Optional. Refers to the "CA" boolean field in the X.509 extension.
	// When this value is missing, the basic constraints extension will be omitted
	// from the certificate.
	IsCa bool `json:"isCa,omitempty"`
	// MaxIssuerPathLength: Optional. Refers to the path length constraint field in
	// the X.509 extension. For a CA certificate, this value describes the depth of
	// subordinate CA certificates that are allowed. If this value is less than 0,
	// the request will fail. If this value is missing, the max path length will be
	// omitted from the certificate.
	MaxIssuerPathLength int64 `json:"maxIssuerPathLength,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IsCa") 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. "IsCa") 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:"-"`
}

CaOptions: Describes the X.509 basic constraints extension, per RFC 5280 section 4.2.1.9 (https://tools.ietf.org/html/rfc5280#section-4.2.1.9)

func (CaOptions) MarshalJSON

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

type CaPool

type CaPool struct {
	// IssuancePolicy: Optional. The IssuancePolicy to control how Certificates
	// will be issued from this CaPool.
	IssuancePolicy *IssuancePolicy `json:"issuancePolicy,omitempty"`
	// Labels: Optional. Labels with user-defined metadata.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Output only. Identifier. The resource name for this CaPool in the
	// format `projects/*/locations/*/caPools/*`.
	Name string `json:"name,omitempty"`
	// PublishingOptions: Optional. The PublishingOptions to follow when issuing
	// Certificates from any CertificateAuthority in this CaPool.
	PublishingOptions *PublishingOptions `json:"publishingOptions,omitempty"`
	// Tier: Required. Immutable. The Tier of this CaPool.
	//
	// Possible values:
	//   "TIER_UNSPECIFIED" - Not specified.
	//   "ENTERPRISE" - Enterprise tier.
	//   "DEVOPS" - DevOps tier.
	Tier string `json:"tier,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "IssuancePolicy") 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. "IssuancePolicy") 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:"-"`
}

CaPool: A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor.

func (CaPool) MarshalJSON

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

type CancelOperationRequest

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type CertChain

type CertChain struct {
	// Certificates: The certificates that form the CA chain, from leaf to root
	// order.
	Certificates []string `json:"certificates,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Certificates") 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. "Certificates") 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:"-"`
}

func (CertChain) MarshalJSON

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

type Certificate

type Certificate struct {
	// CertificateDescription: Output only. A structured description of the issued
	// X.509 certificate.
	CertificateDescription *CertificateDescription `json:"certificateDescription,omitempty"`
	// CertificateTemplate: Immutable. The resource name for a CertificateTemplate
	// used to issue this certificate, in the format
	// `projects/*/locations/*/certificateTemplates/*`. If this is specified, the
	// caller must have the necessary permission to use this template. If this is
	// omitted, no template will be used. This template must be in the same
	// location as the Certificate.
	CertificateTemplate string `json:"certificateTemplate,omitempty"`
	// Config: Immutable. A description of the certificate and key that does not
	// require X.509 or ASN.1.
	Config *CertificateConfig `json:"config,omitempty"`
	// CreateTime: Output only. The time at which this Certificate was created.
	CreateTime string `json:"createTime,omitempty"`
	// IssuerCertificateAuthority: Output only. The resource name of the issuing
	// CertificateAuthority in the format
	// `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
	IssuerCertificateAuthority string `json:"issuerCertificateAuthority,omitempty"`
	// Labels: Optional. Labels with user-defined metadata.
	Labels map[string]string `json:"labels,omitempty"`
	// Lifetime: Required. Immutable. The desired lifetime of a certificate. Used
	// to create the "not_before_time" and "not_after_time" fields inside an X.509
	// certificate. Note that the lifetime may be truncated if it would extend past
	// the life of any certificate authority in the issuing chain.
	Lifetime string `json:"lifetime,omitempty"`
	// Name: Output only. The resource name for this Certificate in the format
	// `projects/*/locations/*/caPools/*/certificates/*`.
	Name string `json:"name,omitempty"`
	// PemCertificate: Output only. The pem-encoded, signed X.509 certificate.
	PemCertificate string `json:"pemCertificate,omitempty"`
	// PemCertificateChain: Output only. The chain that may be used to verify the
	// X.509 certificate. Expected to be in issuer-to-root order according to RFC
	// 5246.
	PemCertificateChain []string `json:"pemCertificateChain,omitempty"`
	// PemCsr: Immutable. A pem-encoded X.509 certificate signing request (CSR).
	PemCsr string `json:"pemCsr,omitempty"`
	// RevocationDetails: Output only. Details regarding the revocation of this
	// Certificate. This Certificate is considered revoked if and only if this
	// field is present.
	RevocationDetails *RevocationDetails `json:"revocationDetails,omitempty"`
	// SubjectMode: Immutable. Specifies how the Certificate's identity fields are
	// to be decided. If this is omitted, the `DEFAULT` subject mode will be used.
	//
	// Possible values:
	//   "SUBJECT_REQUEST_MODE_UNSPECIFIED" - Not specified.
	//   "DEFAULT" - The default mode used in most cases. Indicates that the
	// certificate's Subject and/or SubjectAltNames are specified in the
	// certificate request. This mode requires the caller to have the
	// `privateca.certificates.create` permission.
	//   "REFLECTED_SPIFFE" - A mode reserved for special cases. Indicates that the
	// certificate should have one SPIFFE SubjectAltNames set by the service based
	// on the caller's identity. This mode will ignore any explicitly specified
	// Subject and/or SubjectAltNames in the certificate request. This mode
	// requires the caller to have the `privateca.certificates.createForSelf`
	// permission.
	SubjectMode string `json:"subjectMode,omitempty"`
	// UpdateTime: Output only. The time at which this Certificate was updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CertificateDescription") 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. "CertificateDescription") 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:"-"`
}

Certificate: A Certificate corresponds to a signed X.509 certificate issued by a CertificateAuthority.

func (Certificate) MarshalJSON

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

type CertificateAuthority

type CertificateAuthority struct {
	// AccessUrls: Output only. URLs for accessing content published by this CA,
	// such as the CA certificate and CRLs.
	AccessUrls *AccessUrls `json:"accessUrls,omitempty"`
	// CaCertificateDescriptions: Output only. A structured description of this
	// CertificateAuthority's CA certificate and its issuers. Ordered as
	// self-to-root.
	CaCertificateDescriptions []*CertificateDescription `json:"caCertificateDescriptions,omitempty"`
	// Config: Required. Immutable. The config used to create a self-signed X.509
	// certificate or CSR.
	Config *CertificateConfig `json:"config,omitempty"`
	// CreateTime: Output only. The time at which this CertificateAuthority was
	// created.
	CreateTime string `json:"createTime,omitempty"`
	// DeleteTime: Output only. The time at which this CertificateAuthority was
	// soft deleted, if it is in the DELETED state.
	DeleteTime string `json:"deleteTime,omitempty"`
	// ExpireTime: Output only. The time at which this CertificateAuthority will be
	// permanently purged, if it is in the DELETED state.
	ExpireTime string `json:"expireTime,omitempty"`
	// GcsBucket: Immutable. The name of a Cloud Storage bucket where this
	// CertificateAuthority will publish content, such as the CA certificate and
	// CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or
	// suffixes (such as `.googleapis.com`). For example, to use a bucket named
	// `my-bucket`, you would simply specify `my-bucket`. If not specified, a
	// managed bucket will be created.
	GcsBucket string `json:"gcsBucket,omitempty"`
	// KeySpec: Required. Immutable. Used when issuing certificates for this
	// CertificateAuthority. If this CertificateAuthority is a self-signed
	// CertificateAuthority, this key is also used to sign the self-signed CA
	// certificate. Otherwise, it is used to sign a CSR.
	KeySpec *KeyVersionSpec `json:"keySpec,omitempty"`
	// Labels: Optional. Labels with user-defined metadata.
	Labels map[string]string `json:"labels,omitempty"`
	// Lifetime: Required. Immutable. The desired lifetime of the CA certificate.
	// Used to create the "not_before_time" and "not_after_time" fields inside an
	// X.509 certificate.
	Lifetime string `json:"lifetime,omitempty"`
	// Name: Output only. Identifier. The resource name for this
	// CertificateAuthority in the format
	// `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
	Name string `json:"name,omitempty"`
	// PemCaCertificates: Output only. This CertificateAuthority's certificate
	// chain, including the current CertificateAuthority's certificate. Ordered
	// such that the root issuer is the final element (consistent with RFC 5246).
	// For a self-signed CA, this will only list the current CertificateAuthority's
	// certificate.
	PemCaCertificates []string `json:"pemCaCertificates,omitempty"`
	// SatisfiesPzi: Output only. Reserved for future use.
	SatisfiesPzi bool `json:"satisfiesPzi,omitempty"`
	// SatisfiesPzs: Output only. Reserved for future use.
	SatisfiesPzs bool `json:"satisfiesPzs,omitempty"`
	// State: Output only. The State for this CertificateAuthority.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Not specified.
	//   "ENABLED" - Certificates can be issued from this CA. CRLs will be
	// generated for this CA. The CA will be part of the CaPool's trust anchor, and
	// will be used to issue certificates from the CaPool.
	//   "DISABLED" - Certificates cannot be issued from this CA. CRLs will still
	// be generated. The CA will be part of the CaPool's trust anchor, but will not
	// be used to issue certificates from the CaPool.
	//   "STAGED" - Certificates can be issued from this CA. CRLs will be generated
	// for this CA. The CA will be part of the CaPool's trust anchor, but will not
	// be used to issue certificates from the CaPool.
	//   "AWAITING_USER_ACTIVATION" - Certificates cannot be issued from this CA.
	// CRLs will not be generated. The CA will not be part of the CaPool's trust
	// anchor, and will not be used to issue certificates from the CaPool.
	//   "DELETED" - Certificates cannot be issued from this CA. CRLs will not be
	// generated. The CA may still be recovered by calling
	// CertificateAuthorityService.UndeleteCertificateAuthority before expire_time.
	// The CA will not be part of the CaPool's trust anchor, and will not be used
	// to issue certificates from the CaPool.
	State string `json:"state,omitempty"`
	// SubordinateConfig: Optional. If this is a subordinate CertificateAuthority,
	// this field will be set with the subordinate configuration, which describes
	// its issuers. This may be updated, but this CertificateAuthority must
	// continue to validate.
	SubordinateConfig *SubordinateConfig `json:"subordinateConfig,omitempty"`
	// Tier: Output only. The CaPool.Tier of the CaPool that includes this
	// CertificateAuthority.
	//
	// Possible values:
	//   "TIER_UNSPECIFIED" - Not specified.
	//   "ENTERPRISE" - Enterprise tier.
	//   "DEVOPS" - DevOps tier.
	Tier string `json:"tier,omitempty"`
	// Type: Required. Immutable. The Type of this CertificateAuthority.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Not specified.
	//   "SELF_SIGNED" - Self-signed CA.
	//   "SUBORDINATE" - Subordinate CA. Could be issued by a Private CA
	// CertificateAuthority or an unmanaged CA.
	Type string `json:"type,omitempty"`
	// UpdateTime: Output only. The time at which this CertificateAuthority was
	// last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AccessUrls") 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. "AccessUrls") 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:"-"`
}

CertificateAuthority: A CertificateAuthority represents an individual Certificate Authority. A CertificateAuthority can be used to create Certificates.

func (CertificateAuthority) MarshalJSON

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

type CertificateConfig

type CertificateConfig struct {
	// PublicKey: Optional. The public key that corresponds to this config. This
	// is, for example, used when issuing Certificates, but not when creating a
	// self-signed CertificateAuthority or CertificateAuthority CSR.
	PublicKey *PublicKey `json:"publicKey,omitempty"`
	// SubjectConfig: Required. Specifies some of the values in a certificate that
	// are related to the subject.
	SubjectConfig *SubjectConfig `json:"subjectConfig,omitempty"`
	// SubjectKeyId: Optional. When specified this provides a custom SKI to be used
	// in the certificate. This should only be used to maintain a SKI of an
	// existing CA originally created outside CA service, which was not generated
	// using method (1) described in RFC 5280 section 4.2.1.2.
	SubjectKeyId *CertificateConfigKeyId `json:"subjectKeyId,omitempty"`
	// X509Config: Required. Describes how some of the technical X.509 fields in a
	// certificate should be populated.
	X509Config *X509Parameters `json:"x509Config,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PublicKey") 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. "PublicKey") 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:"-"`
}

CertificateConfig: A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1.

func (CertificateConfig) MarshalJSON

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

type CertificateConfigKeyId added in v0.168.0

type CertificateConfigKeyId struct {
	// KeyId: Required. The value of this KeyId encoded in lowercase hexadecimal.
	// This is most likely the 160 bit SHA-1 hash of the public key.
	KeyId string `json:"keyId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KeyId") 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. "KeyId") 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:"-"`
}

CertificateConfigKeyId: A KeyId identifies a specific public key, usually by hashing the public key.

func (CertificateConfigKeyId) MarshalJSON added in v0.168.0

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

type CertificateDescription

type CertificateDescription struct {
	// AiaIssuingCertificateUrls: Describes lists of issuer CA certificate URLs
	// that appear in the "Authority Information Access" extension in the
	// certificate.
	AiaIssuingCertificateUrls []string `json:"aiaIssuingCertificateUrls,omitempty"`
	// AuthorityKeyId: Identifies the subject_key_id of the parent certificate, per
	// https://tools.ietf.org/html/rfc5280#section-4.2.1.1
	AuthorityKeyId *KeyId `json:"authorityKeyId,omitempty"`
	// CertFingerprint: The hash of the x.509 certificate.
	CertFingerprint *CertificateFingerprint `json:"certFingerprint,omitempty"`
	// CrlDistributionPoints: Describes a list of locations to obtain CRL
	// information, i.e. the DistributionPoint.fullName described by
	// https://tools.ietf.org/html/rfc5280#section-4.2.1.13
	CrlDistributionPoints []string `json:"crlDistributionPoints,omitempty"`
	// PublicKey: The public key that corresponds to an issued certificate.
	PublicKey *PublicKey `json:"publicKey,omitempty"`
	// SubjectDescription: Describes some of the values in a certificate that are
	// related to the subject and lifetime.
	SubjectDescription *SubjectDescription `json:"subjectDescription,omitempty"`
	// SubjectKeyId: Provides a means of identifiying certificates that contain a
	// particular public key, per
	// https://tools.ietf.org/html/rfc5280#section-4.2.1.2.
	SubjectKeyId *KeyId `json:"subjectKeyId,omitempty"`
	// TbsCertificateDigest: The hash of the pre-signed certificate, which will be
	// signed by the CA. Corresponds to the TBS Certificate in
	// https://tools.ietf.org/html/rfc5280#section-4.1.2. The field will always be
	// populated.
	TbsCertificateDigest string `json:"tbsCertificateDigest,omitempty"`
	// X509Description: Describes some of the technical X.509 fields in a
	// certificate.
	X509Description *X509Parameters `json:"x509Description,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AiaIssuingCertificateUrls")
	// 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. "AiaIssuingCertificateUrls") 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:"-"`
}

CertificateDescription: A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509.

func (CertificateDescription) MarshalJSON

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

type CertificateExtensionConstraints

type CertificateExtensionConstraints struct {
	// AdditionalExtensions: Optional. A set of ObjectIds identifying custom X.509
	// extensions. Will be combined with known_extensions to determine the full set
	// of X.509 extensions.
	AdditionalExtensions []*ObjectId `json:"additionalExtensions,omitempty"`
	// KnownExtensions: Optional. A set of named X.509 extensions. Will be combined
	// with additional_extensions to determine the full set of X.509 extensions.
	//
	// Possible values:
	//   "KNOWN_CERTIFICATE_EXTENSION_UNSPECIFIED" - Not specified.
	//   "BASE_KEY_USAGE" - Refers to a certificate's Key Usage extension, as
	// described in [RFC 5280 section
	// 4.2.1.3](https://tools.ietf.org/html/rfc5280#section-4.2.1.3). This
	// corresponds to the KeyUsage.base_key_usage field.
	//   "EXTENDED_KEY_USAGE" - Refers to a certificate's Extended Key Usage
	// extension, as described in [RFC 5280 section
	// 4.2.1.12](https://tools.ietf.org/html/rfc5280#section-4.2.1.12). This
	// corresponds to the KeyUsage.extended_key_usage message.
	//   "CA_OPTIONS" - Refers to a certificate's Basic Constraints extension, as
	// described in [RFC 5280 section
	// 4.2.1.9](https://tools.ietf.org/html/rfc5280#section-4.2.1.9). This
	// corresponds to the X509Parameters.ca_options field.
	//   "POLICY_IDS" - Refers to a certificate's Policy object identifiers, as
	// described in [RFC 5280 section
	// 4.2.1.4](https://tools.ietf.org/html/rfc5280#section-4.2.1.4). This
	// corresponds to the X509Parameters.policy_ids field.
	//   "AIA_OCSP_SERVERS" - Refers to OCSP servers in a certificate's Authority
	// Information Access extension, as described in [RFC 5280 section
	// 4.2.2.1](https://tools.ietf.org/html/rfc5280#section-4.2.2.1), This
	// corresponds to the X509Parameters.aia_ocsp_servers field.
	//   "NAME_CONSTRAINTS" - Refers to Name Constraints extension as described in
	// [RFC 5280 section
	// 4.2.1.10](https://tools.ietf.org/html/rfc5280#section-4.2.1.10)
	KnownExtensions []string `json:"knownExtensions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalExtensions") 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. "AdditionalExtensions") 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:"-"`
}

CertificateExtensionConstraints: Describes a set of X.509 extensions that may be part of some certificate issuance controls.

func (CertificateExtensionConstraints) MarshalJSON

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

type CertificateFingerprint

type CertificateFingerprint struct {
	// Sha256Hash: The SHA 256 hash, encoded in hexadecimal, of the DER x509
	// certificate.
	Sha256Hash string `json:"sha256Hash,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Sha256Hash") 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. "Sha256Hash") 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:"-"`
}

CertificateFingerprint: A group of fingerprints for the x509 certificate.

func (CertificateFingerprint) MarshalJSON

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

type CertificateIdentityConstraints

type CertificateIdentityConstraints struct {
	// AllowSubjectAltNamesPassthrough: Required. If this is true, the
	// SubjectAltNames extension may be copied from a certificate request into the
	// signed certificate. Otherwise, the requested SubjectAltNames will be
	// discarded.
	AllowSubjectAltNamesPassthrough bool `json:"allowSubjectAltNamesPassthrough,omitempty"`
	// AllowSubjectPassthrough: Required. If this is true, the Subject field may be
	// copied from a certificate request into the signed certificate. Otherwise,
	// the requested Subject will be discarded.
	AllowSubjectPassthrough bool `json:"allowSubjectPassthrough,omitempty"`
	// CelExpression: Optional. A CEL expression that may be used to validate the
	// resolved X.509 Subject and/or Subject Alternative Name before a certificate
	// is signed. To see the full allowed syntax and some examples, see
	// https://cloud.google.com/certificate-authority-service/docs/using-cel
	CelExpression *Expr `json:"celExpression,omitempty"`
	// ForceSendFields is a list of field names (e.g.
	// "AllowSubjectAltNamesPassthrough") 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. "AllowSubjectAltNamesPassthrough")
	// 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:"-"`
}

CertificateIdentityConstraints: Describes constraints on a Certificate's Subject and SubjectAltNames.

func (CertificateIdentityConstraints) MarshalJSON

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

type CertificateRevocationList

type CertificateRevocationList struct {
	// AccessUrl: Output only. The location where 'pem_crl' can be accessed.
	AccessUrl string `json:"accessUrl,omitempty"`
	// CreateTime: Output only. The time at which this CertificateRevocationList
	// was created.
	CreateTime string `json:"createTime,omitempty"`
	// Labels: Optional. Labels with user-defined metadata.
	Labels map[string]string `json:"labels,omitempty"`
	// Name: Output only. The resource name for this CertificateRevocationList in
	// the format `projects/*/locations/*/caPools/*certificateAuthorities/*/
	// certificateRevocationLists/*`.
	Name string `json:"name,omitempty"`
	// PemCrl: Output only. The PEM-encoded X.509 CRL.
	PemCrl string `json:"pemCrl,omitempty"`
	// RevisionId: Output only. The revision ID of this CertificateRevocationList.
	// A new revision is committed whenever a new CRL is published. The format is
	// an 8-character hexadecimal string.
	RevisionId string `json:"revisionId,omitempty"`
	// RevokedCertificates: Output only. The revoked serial numbers that appear in
	// pem_crl.
	RevokedCertificates []*RevokedCertificate `json:"revokedCertificates,omitempty"`
	// SequenceNumber: Output only. The CRL sequence number that appears in
	// pem_crl.
	SequenceNumber int64 `json:"sequenceNumber,omitempty,string"`
	// State: Output only. The State for this CertificateRevocationList.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Not specified.
	//   "ACTIVE" - The CertificateRevocationList is up to date.
	//   "SUPERSEDED" - The CertificateRevocationList is no longer current.
	State string `json:"state,omitempty"`
	// UpdateTime: Output only. The time at which this CertificateRevocationList
	// was updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AccessUrl") 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. "AccessUrl") 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:"-"`
}

CertificateRevocationList: A CertificateRevocationList corresponds to a signed X.509 certificate Revocation List (CRL). A CRL contains the serial numbers of certificates that should no longer be trusted.

func (CertificateRevocationList) MarshalJSON

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

type CertificateTemplate

type CertificateTemplate struct {
	// CreateTime: Output only. The time at which this CertificateTemplate was
	// created.
	CreateTime string `json:"createTime,omitempty"`
	// Description: Optional. A human-readable description of scenarios this
	// template is intended for.
	Description string `json:"description,omitempty"`
	// IdentityConstraints: Optional. Describes constraints on identities that may
	// be appear in Certificates issued using this template. If this is omitted,
	// then this template will not add restrictions on a certificate's identity.
	IdentityConstraints *CertificateIdentityConstraints `json:"identityConstraints,omitempty"`
	// Labels: Optional. Labels with user-defined metadata.
	Labels map[string]string `json:"labels,omitempty"`
	// MaximumLifetime: Optional. The maximum lifetime allowed for issued
	// Certificates that use this template. If the issuing CaPool resource's
	// IssuancePolicy specifies a maximum_lifetime the minimum of the two durations
	// will be the maximum lifetime for issued Certificates. Note that if the
	// issuing CertificateAuthority expires before a Certificate's requested
	// maximum_lifetime, the effective lifetime will be explicitly truncated to
	// match it.
	MaximumLifetime string `json:"maximumLifetime,omitempty"`
	// Name: Output only. The resource name for this CertificateTemplate in the
	// format `projects/*/locations/*/certificateTemplates/*`.
	Name string `json:"name,omitempty"`
	// PassthroughExtensions: Optional. Describes the set of X.509 extensions that
	// may appear in a Certificate issued using this CertificateTemplate. If a
	// certificate request sets extensions that don't appear in the
	// passthrough_extensions, those extensions will be dropped. If the issuing
	// CaPool's IssuancePolicy defines baseline_values that don't appear here, the
	// certificate issuance request will fail. If this is omitted, then this
	// template will not add restrictions on a certificate's X.509 extensions.
	// These constraints do not apply to X.509 extensions set in this
	// CertificateTemplate's predefined_values.
	PassthroughExtensions *CertificateExtensionConstraints `json:"passthroughExtensions,omitempty"`
	// PredefinedValues: Optional. A set of X.509 values that will be applied to
	// all issued certificates that use this template. If the certificate request
	// includes conflicting values for the same properties, they will be
	// overwritten by the values defined here. If the issuing CaPool's
	// IssuancePolicy defines conflicting baseline_values for the same properties,
	// the certificate issuance request will fail.
	PredefinedValues *X509Parameters `json:"predefinedValues,omitempty"`
	// UpdateTime: Output only. The time at which this CertificateTemplate was
	// updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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:"-"`
}

CertificateTemplate: A CertificateTemplate refers to a managed template for certificate issuance.

func (CertificateTemplate) MarshalJSON

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

type DisableCertificateAuthorityRequest

type DisableCertificateAuthorityRequest struct {
	// IgnoreDependentResources: Optional. This field allows this CA to be disabled
	// even if it's being depended on by another resource. However, doing so may
	// result in unintended and unrecoverable effects on any dependent resources
	// since the CA will no longer be able to issue certificates.
	IgnoreDependentResources bool `json:"ignoreDependentResources,omitempty"`
	// RequestId: Optional. An ID to identify requests. Specify a unique request ID
	// so that if you must retry your request, the server will know to ignore the
	// request if it has already been completed. The server will guarantee that for
	// at least 60 minutes since the first request. For example, consider a
	// situation where you make an initial request and the request times out. If
	// you make the request again with the same request ID, the server can check if
	// original operation with the same request ID was received, and if so, will
	// ignore the second request. This prevents clients from accidentally creating
	// duplicate commitments. The request ID must be a valid UUID with the
	// exception that zero UUID is not supported
	// (00000000-0000-0000-0000-000000000000).
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "IgnoreDependentResources")
	// 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. "IgnoreDependentResources") 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:"-"`
}

DisableCertificateAuthorityRequest: Request message for CertificateAuthorityService.DisableCertificateAuthority.

func (DisableCertificateAuthorityRequest) MarshalJSON

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

type EcKeyType

type EcKeyType struct {
	// SignatureAlgorithm: Optional. A signature algorithm that must be used. If
	// this is omitted, any EC-based signature algorithm will be allowed.
	//
	// Possible values:
	//   "EC_SIGNATURE_ALGORITHM_UNSPECIFIED" - Not specified. Signifies that any
	// signature algorithm may be used.
	//   "ECDSA_P256" - Refers to the Elliptic Curve Digital Signature Algorithm
	// over the NIST P-256 curve.
	//   "ECDSA_P384" - Refers to the Elliptic Curve Digital Signature Algorithm
	// over the NIST P-384 curve.
	//   "EDDSA_25519" - Refers to the Edwards-curve Digital Signature Algorithm
	// over curve 25519, as described in RFC 8410.
	SignatureAlgorithm string `json:"signatureAlgorithm,omitempty"`
	// ForceSendFields is a list of field names (e.g. "SignatureAlgorithm") 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. "SignatureAlgorithm") 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:"-"`
}

EcKeyType: Describes an Elliptic Curve key that may be used in a Certificate issued from a CaPool.

func (EcKeyType) MarshalJSON

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

type Empty

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

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

type EnableCertificateAuthorityRequest

type EnableCertificateAuthorityRequest struct {
	// RequestId: Optional. An ID to identify requests. Specify a unique request ID
	// so that if you must retry your request, the server will know to ignore the
	// request if it has already been completed. The server will guarantee that for
	// at least 60 minutes since the first request. For example, consider a
	// situation where you make an initial request and the request times out. If
	// you make the request again with the same request ID, the server can check if
	// original operation with the same request ID was received, and if so, will
	// ignore the second request. This prevents clients from accidentally creating
	// duplicate commitments. The request ID must be a valid UUID with the
	// exception that zero UUID is not supported
	// (00000000-0000-0000-0000-000000000000).
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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:"-"`
}

EnableCertificateAuthorityRequest: Request message for CertificateAuthorityService.EnableCertificateAuthority.

func (EnableCertificateAuthorityRequest) MarshalJSON

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

type Expr

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

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

func (Expr) MarshalJSON

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

type ExtendedKeyUsageOptions

type ExtendedKeyUsageOptions struct {
	// ClientAuth: Corresponds to OID 1.3.6.1.5.5.7.3.2. Officially described as
	// "TLS WWW client authentication", though regularly used for non-WWW TLS.
	ClientAuth bool `json:"clientAuth,omitempty"`
	// CodeSigning: Corresponds to OID 1.3.6.1.5.5.7.3.3. Officially described as
	// "Signing of downloadable executable code client authentication".
	CodeSigning bool `json:"codeSigning,omitempty"`
	// EmailProtection: Corresponds to OID 1.3.6.1.5.5.7.3.4. Officially described
	// as "Email protection".
	EmailProtection bool `json:"emailProtection,omitempty"`
	// OcspSigning: Corresponds to OID 1.3.6.1.5.5.7.3.9. Officially described as
	// "Signing OCSP responses".
	OcspSigning bool `json:"ocspSigning,omitempty"`
	// ServerAuth: Corresponds to OID 1.3.6.1.5.5.7.3.1. Officially described as
	// "TLS WWW server authentication", though regularly used for non-WWW TLS.
	ServerAuth bool `json:"serverAuth,omitempty"`
	// TimeStamping: Corresponds to OID 1.3.6.1.5.5.7.3.8. Officially described as
	// "Binding the hash of an object to a time".
	TimeStamping bool `json:"timeStamping,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ClientAuth") 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. "ClientAuth") 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:"-"`
}

ExtendedKeyUsageOptions: KeyUsage.ExtendedKeyUsageOptions has fields that correspond to certain common OIDs that could be specified as an extended key usage value.

func (ExtendedKeyUsageOptions) MarshalJSON

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

type FetchCaCertsRequest

type FetchCaCertsRequest struct {
	// RequestId: Optional. An ID to identify requests. Specify a unique request ID
	// so that if you must retry your request, the server will know to ignore the
	// request if it has already been completed. The server will guarantee that for
	// at least 60 minutes since the first request. For example, consider a
	// situation where you make an initial request and the request times out. If
	// you make the request again with the same request ID, the server can check if
	// original operation with the same request ID was received, and if so, will
	// ignore the second request. This prevents clients from accidentally creating
	// duplicate commitments. The request ID must be a valid UUID with the
	// exception that zero UUID is not supported
	// (00000000-0000-0000-0000-000000000000).
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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:"-"`
}

FetchCaCertsRequest: Request message for CertificateAuthorityService.FetchCaCerts.

func (FetchCaCertsRequest) MarshalJSON

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

type FetchCaCertsResponse

type FetchCaCertsResponse struct {
	// CaCerts: The PEM encoded CA certificate chains of all certificate
	// authorities in this CaPool in the ENABLED, DISABLED, or STAGED states.
	CaCerts []*CertChain `json:"caCerts,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CaCerts") 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. "CaCerts") 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:"-"`
}

FetchCaCertsResponse: Response message for CertificateAuthorityService.FetchCaCerts.

func (FetchCaCertsResponse) MarshalJSON

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

type FetchCertificateAuthorityCsrResponse

type FetchCertificateAuthorityCsrResponse struct {
	// PemCsr: Output only. The PEM-encoded signed certificate signing request
	// (CSR).
	PemCsr string `json:"pemCsr,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "PemCsr") 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. "PemCsr") 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:"-"`
}

FetchCertificateAuthorityCsrResponse: Response message for CertificateAuthorityService.FetchCertificateAuthorityCsr.

func (FetchCertificateAuthorityCsrResponse) MarshalJSON

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

type IssuanceModes

type IssuanceModes struct {
	// AllowConfigBasedIssuance: Optional. When true, allows callers to create
	// Certificates by specifying a CertificateConfig.
	AllowConfigBasedIssuance bool `json:"allowConfigBasedIssuance,omitempty"`
	// AllowCsrBasedIssuance: Optional. When true, allows callers to create
	// Certificates by specifying a CSR.
	AllowCsrBasedIssuance bool `json:"allowCsrBasedIssuance,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowConfigBasedIssuance")
	// 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. "AllowConfigBasedIssuance") 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:"-"`
}

IssuanceModes: IssuanceModes specifies the allowed ways in which Certificates may be requested from this CaPool.

func (IssuanceModes) MarshalJSON

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

type IssuancePolicy

type IssuancePolicy struct {
	// AllowedIssuanceModes: Optional. If specified, then only methods allowed in
	// the IssuanceModes may be used to issue Certificates.
	AllowedIssuanceModes *IssuanceModes `json:"allowedIssuanceModes,omitempty"`
	// AllowedKeyTypes: Optional. If any AllowedKeyType is specified, then the
	// certificate request's public key must match one of the key types listed
	// here. Otherwise, any key may be used.
	AllowedKeyTypes []*AllowedKeyType `json:"allowedKeyTypes,omitempty"`
	// BaselineValues: Optional. A set of X.509 values that will be applied to all
	// certificates issued through this CaPool. If a certificate request includes
	// conflicting values for the same properties, they will be overwritten by the
	// values defined here. If a certificate request uses a CertificateTemplate
	// that defines conflicting predefined_values for the same properties, the
	// certificate issuance request will fail.
	BaselineValues *X509Parameters `json:"baselineValues,omitempty"`
	// IdentityConstraints: Optional. Describes constraints on identities that may
	// appear in Certificates issued through this CaPool. If this is omitted, then
	// this CaPool will not add restrictions on a certificate's identity.
	IdentityConstraints *CertificateIdentityConstraints `json:"identityConstraints,omitempty"`
	// MaximumLifetime: Optional. The maximum lifetime allowed for issued
	// Certificates. Note that if the issuing CertificateAuthority expires before a
	// Certificate resource's requested maximum_lifetime, the effective lifetime
	// will be explicitly truncated to match it.
	MaximumLifetime string `json:"maximumLifetime,omitempty"`
	// PassthroughExtensions: Optional. Describes the set of X.509 extensions that
	// may appear in a Certificate issued through this CaPool. If a certificate
	// request sets extensions that don't appear in the passthrough_extensions,
	// those extensions will be dropped. If a certificate request uses a
	// CertificateTemplate with predefined_values that don't appear here, the
	// certificate issuance request will fail. If this is omitted, then this CaPool
	// will not add restrictions on a certificate's X.509 extensions. These
	// constraints do not apply to X.509 extensions set in this CaPool's
	// baseline_values.
	PassthroughExtensions *CertificateExtensionConstraints `json:"passthroughExtensions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AllowedIssuanceModes") 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. "AllowedIssuanceModes") 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:"-"`
}

IssuancePolicy: Defines controls over all certificate issuance within a CaPool.

func (IssuancePolicy) MarshalJSON

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

type KeyId

type KeyId struct {
	// KeyId: Optional. The value of this KeyId encoded in lowercase hexadecimal.
	// This is most likely the 160 bit SHA-1 hash of the public key.
	KeyId string `json:"keyId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "KeyId") 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. "KeyId") 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:"-"`
}

KeyId: A KeyId identifies a specific public key, usually by hashing the public key.

func (KeyId) MarshalJSON

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

type KeyUsage

type KeyUsage struct {
	// BaseKeyUsage: Describes high-level ways in which a key may be used.
	BaseKeyUsage *KeyUsageOptions `json:"baseKeyUsage,omitempty"`
	// ExtendedKeyUsage: Detailed scenarios in which a key may be used.
	ExtendedKeyUsage *ExtendedKeyUsageOptions `json:"extendedKeyUsage,omitempty"`
	// UnknownExtendedKeyUsages: Used to describe extended key usages that are not
	// listed in the KeyUsage.ExtendedKeyUsageOptions message.
	UnknownExtendedKeyUsages []*ObjectId `json:"unknownExtendedKeyUsages,omitempty"`
	// ForceSendFields is a list of field names (e.g. "BaseKeyUsage") 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. "BaseKeyUsage") 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:"-"`
}

KeyUsage: A KeyUsage describes key usage values that may appear in an X.509 certificate.

func (KeyUsage) MarshalJSON

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

type KeyUsageOptions

type KeyUsageOptions struct {
	// CertSign: The key may be used to sign certificates.
	CertSign bool `json:"certSign,omitempty"`
	// ContentCommitment: The key may be used for cryptographic commitments. Note
	// that this may also be referred to as "non-repudiation".
	ContentCommitment bool `json:"contentCommitment,omitempty"`
	// CrlSign: The key may be used sign certificate revocation lists.
	CrlSign bool `json:"crlSign,omitempty"`
	// DataEncipherment: The key may be used to encipher data.
	DataEncipherment bool `json:"dataEncipherment,omitempty"`
	// DecipherOnly: The key may be used to decipher only.
	DecipherOnly bool `json:"decipherOnly,omitempty"`
	// DigitalSignature: The key may be used for digital signatures.
	DigitalSignature bool `json:"digitalSignature,omitempty"`
	// EncipherOnly: The key may be used to encipher only.
	EncipherOnly bool `json:"encipherOnly,omitempty"`
	// KeyAgreement: The key may be used in a key agreement protocol.
	KeyAgreement bool `json:"keyAgreement,omitempty"`
	// KeyEncipherment: The key may be used to encipher other keys.
	KeyEncipherment bool `json:"keyEncipherment,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CertSign") 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. "CertSign") 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:"-"`
}

KeyUsageOptions: KeyUsage.KeyUsageOptions corresponds to the key usage values described in https://tools.ietf.org/html/rfc5280#section-4.2.1.3.

func (KeyUsageOptions) MarshalJSON

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

type KeyVersionSpec

type KeyVersionSpec struct {
	// Algorithm: The algorithm to use for creating a managed Cloud KMS key for a
	// for a simplified experience. All managed keys will be have their
	// ProtectionLevel as `HSM`.
	//
	// Possible values:
	//   "SIGN_HASH_ALGORITHM_UNSPECIFIED" - Not specified.
	//   "RSA_PSS_2048_SHA256" - maps to
	// CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_2048_SHA256
	//   "RSA_PSS_3072_SHA256" - maps to CryptoKeyVersionAlgorithm.
	// RSA_SIGN_PSS_3072_SHA256
	//   "RSA_PSS_4096_SHA256" - maps to
	// CryptoKeyVersionAlgorithm.RSA_SIGN_PSS_4096_SHA256
	//   "RSA_PKCS1_2048_SHA256" - maps to
	// CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_2048_SHA256
	//   "RSA_PKCS1_3072_SHA256" - maps to
	// CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_3072_SHA256
	//   "RSA_PKCS1_4096_SHA256" - maps to
	// CryptoKeyVersionAlgorithm.RSA_SIGN_PKCS1_4096_SHA256
	//   "EC_P256_SHA256" - maps to CryptoKeyVersionAlgorithm.EC_SIGN_P256_SHA256
	//   "EC_P384_SHA384" - maps to CryptoKeyVersionAlgorithm.EC_SIGN_P384_SHA384
	Algorithm string `json:"algorithm,omitempty"`
	// CloudKmsKeyVersion: The resource name for an existing Cloud KMS
	// CryptoKeyVersion in the format
	// `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. This
	// option enables full flexibility in the key's capabilities and properties.
	CloudKmsKeyVersion string `json:"cloudKmsKeyVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Algorithm") 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. "Algorithm") 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:"-"`
}

KeyVersionSpec: A Cloud KMS key configuration that a CertificateAuthority will use.

func (KeyVersionSpec) MarshalJSON

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

type ListCaPoolsResponse

type ListCaPoolsResponse struct {
	// CaPools: The list of CaPools.
	CaPools []*CaPool `json:"caPools,omitempty"`
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// ListCertificateAuthoritiesRequest.page_token to retrieve the next page of
	// results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: A list of locations (e.g. "us-west1") that could not be
	// reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CaPools") 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. "CaPools") 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:"-"`
}

ListCaPoolsResponse: Response message for CertificateAuthorityService.ListCaPools.

func (ListCaPoolsResponse) MarshalJSON

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

type ListCertificateAuthoritiesResponse

type ListCertificateAuthoritiesResponse struct {
	// CertificateAuthorities: The list of CertificateAuthorities.
	CertificateAuthorities []*CertificateAuthority `json:"certificateAuthorities,omitempty"`
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// ListCertificateAuthoritiesRequest.page_token to retrieve the next page of
	// results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: A list of locations (e.g. "us-west1") that could not be
	// reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CertificateAuthorities") 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. "CertificateAuthorities") 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:"-"`
}

ListCertificateAuthoritiesResponse: Response message for CertificateAuthorityService.ListCertificateAuthorities.

func (ListCertificateAuthoritiesResponse) MarshalJSON

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

type ListCertificateRevocationListsResponse

type ListCertificateRevocationListsResponse struct {
	// CertificateRevocationLists: The list of CertificateRevocationLists.
	CertificateRevocationLists []*CertificateRevocationList `json:"certificateRevocationLists,omitempty"`
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// ListCertificateRevocationListsRequest.page_token to retrieve the next page
	// of results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: A list of locations (e.g. "us-west1") that could not be
	// reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CertificateRevocationLists")
	// 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. "CertificateRevocationLists") 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:"-"`
}

ListCertificateRevocationListsResponse: Response message for CertificateAuthorityService.ListCertificateRevocationLists.

func (ListCertificateRevocationListsResponse) MarshalJSON

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

type ListCertificateTemplatesResponse

type ListCertificateTemplatesResponse struct {
	// CertificateTemplates: The list of CertificateTemplates.
	CertificateTemplates []*CertificateTemplate `json:"certificateTemplates,omitempty"`
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// ListCertificateTemplatesRequest.page_token to retrieve the next page of
	// results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: A list of locations (e.g. "us-west1") that could not be
	// reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "CertificateTemplates") 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. "CertificateTemplates") 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:"-"`
}

ListCertificateTemplatesResponse: Response message for CertificateAuthorityService.ListCertificateTemplates.

func (ListCertificateTemplatesResponse) MarshalJSON

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

type ListCertificatesResponse

type ListCertificatesResponse struct {
	// Certificates: The list of Certificates.
	Certificates []*Certificate `json:"certificates,omitempty"`
	// NextPageToken: A token to retrieve next page of results. Pass this value in
	// ListCertificatesRequest.page_token to retrieve the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Unreachable: A list of locations (e.g. "us-west1") that could not be
	// reached.
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Certificates") 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. "Certificates") 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:"-"`
}

ListCertificatesResponse: Response message for CertificateAuthorityService.ListCertificates.

func (ListCertificatesResponse) MarshalJSON

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

type ListLocationsResponse

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

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

ListLocationsResponse: The response message for Locations.ListLocations.

func (ListLocationsResponse) MarshalJSON

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

type ListOperationsResponse

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`
	// Operations: A list of operations that matches the specified filter in the
	// request.
	Operations []*Operation `json:"operations,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:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse) MarshalJSON

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

type Location

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

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

Location: A resource that represents a Google Cloud location.

func (Location) MarshalJSON

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

type NameConstraints added in v0.111.0

type NameConstraints struct {
	// Critical: Indicates whether or not the name constraints are marked critical.
	Critical bool `json:"critical,omitempty"`
	// ExcludedDnsNames: Contains excluded DNS names. Any DNS name that can be
	// constructed by simply adding zero or more labels to the left-hand side of
	// the name satisfies the name constraint. For example, `example.com`,
	// `www.example.com`, `www.sub.example.com` would satisfy `example.com` while
	// `example1.com` does not.
	ExcludedDnsNames []string `json:"excludedDnsNames,omitempty"`
	// ExcludedEmailAddresses: Contains the excluded email addresses. The value can
	// be a particular email address, a hostname to indicate all email addresses on
	// that host or a domain with a leading period (e.g. `.example.com`) to
	// indicate all email addresses in that domain.
	ExcludedEmailAddresses []string `json:"excludedEmailAddresses,omitempty"`
	// ExcludedIpRanges: Contains the excluded IP ranges. For IPv4 addresses, the
	// ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6
	// addresses, the ranges are expressed in similar encoding as IPv4 addresses.
	ExcludedIpRanges []string `json:"excludedIpRanges,omitempty"`
	// ExcludedUris: Contains the excluded URIs that apply to the host part of the
	// name. The value can be a hostname or a domain with a leading period (like
	// `.example.com`)
	ExcludedUris []string `json:"excludedUris,omitempty"`
	// PermittedDnsNames: Contains permitted DNS names. Any DNS name that can be
	// constructed by simply adding zero or more labels to the left-hand side of
	// the name satisfies the name constraint. For example, `example.com`,
	// `www.example.com`, `www.sub.example.com` would satisfy `example.com` while
	// `example1.com` does not.
	PermittedDnsNames []string `json:"permittedDnsNames,omitempty"`
	// PermittedEmailAddresses: Contains the permitted email addresses. The value
	// can be a particular email address, a hostname to indicate all email
	// addresses on that host or a domain with a leading period (e.g.
	// `.example.com`) to indicate all email addresses in that domain.
	PermittedEmailAddresses []string `json:"permittedEmailAddresses,omitempty"`
	// PermittedIpRanges: Contains the permitted IP ranges. For IPv4 addresses, the
	// ranges are expressed using CIDR notation as specified in RFC 4632. For IPv6
	// addresses, the ranges are expressed in similar encoding as IPv4 addresses.
	PermittedIpRanges []string `json:"permittedIpRanges,omitempty"`
	// PermittedUris: Contains the permitted URIs that apply to the host part of
	// the name. The value can be a hostname or a domain with a leading period
	// (like `.example.com`)
	PermittedUris []string `json:"permittedUris,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Critical") 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. "Critical") 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:"-"`
}

NameConstraints: Describes the X.509 name constraints extension, per https://tools.ietf.org/html/rfc5280#section-4.2.1.10

func (NameConstraints) MarshalJSON added in v0.111.0

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

type ObjectId

type ObjectId struct {
	// ObjectIdPath: Required. The parts of an OID path. The most significant parts
	// of the path come first.
	ObjectIdPath []int64 `json:"objectIdPath,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ObjectIdPath") 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. "ObjectIdPath") 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:"-"`
}

ObjectId: An ObjectId specifies an object identifier (OID). These provide context and describe types in ASN.1 messages.

func (ObjectId) MarshalJSON

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

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// Error: The error result of the operation in case of failure or cancellation.
	Error *Status `json:"error,omitempty"`
	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as create
	// time. Some services might not provide such metadata. Any method that returns
	// a long-running operation should document the metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
	// Name: The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the `name`
	// should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// Response: The normal, successful response of the operation. If the original
	// method returns no data on success, such as `Delete`, the response is
	// `google.protobuf.Empty`. If the original method is standard
	// `Get`/`Create`/`Update`, the response should be the resource. For other
	// methods, the response should have the type `XxxResponse`, where `Xxx` is the
	// original method name. For example, if the original method name is
	// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Done") 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. "Done") 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:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (Operation) MarshalJSON

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

type OperationMetadata

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// RequestedCancellation: Output only. Identifies whether the user has
	// requested cancellation of the operation. Operations that have successfully
	// been cancelled have google.longrunning.Operation.error value with a
	// google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`
	// StatusMessage: Output only. Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") 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. "ApiVersion") 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:"-"`
}

OperationMetadata: Represents the metadata of the long-running operation.

func (OperationMetadata) MarshalJSON

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

type Policy

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

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

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

func (Policy) MarshalJSON

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesActivateCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesActivateCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesActivateCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesActivateCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesActivateCall) Header

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetCall) IfNoneMatch

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetIamPolicyCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetIamPolicyCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetIamPolicyCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetIamPolicyCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetIamPolicyCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetIamPolicyCall) IfNoneMatch

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsGetIamPolicyCall) OptionsRequestedPolicyVersion

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) Filter

Filter sets the optional parameter "filter": Only include resources that match the filter in the response.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) IfNoneMatch

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of CertificateRevocationLists to include in the response. Further CertificateRevocationLists can subsequently be obtained by including the ListCertificateRevocationListsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) PageToken

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsListCall) 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.

type ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsPatchCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsPatchCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsPatchCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsPatchCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsPatchCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsPatchCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A list of fields to be updated in this request.

type ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsService

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsService) Get

Get: Returns a CertificateRevocationList.

- name: The name of the CertificateRevocationList to get.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsService) GetIamPolicy

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsService) List

List: Lists CertificateRevocationLists.

  • parent: The resource name of the location associated with the CertificateRevocationLists, in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsService) Patch

Patch: Update a CertificateRevocationList.

  • name: Output only. The resource name for this CertificateRevocationList in the format `projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsSetIamPolicyCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsSetIamPolicyCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsSetIamPolicyCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsSetIamPolicyCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsSetIamPolicyCall) Header

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsTestIamPermissionsCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsTestIamPermissionsCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsTestIamPermissionsCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsTestIamPermissionsCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsTestIamPermissionsCall) Header

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesCreateCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCreateCall) CertificateAuthorityId

CertificateAuthorityId sets the optional parameter "certificateAuthorityId": Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCreateCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCreateCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCreateCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCreateCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesCreateCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsCaPoolsCertificateAuthoritiesDeleteCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDeleteCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDeleteCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDeleteCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDeleteCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDeleteCall) IgnoreActiveCertificates

IgnoreActiveCertificates sets the optional parameter "ignoreActiveCertificates": This field allows the CA to be deleted even if the CA has active certs. Active certs include both unrevoked and unexpired certs.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDeleteCall) IgnoreDependentResources added in v0.117.0

IgnoreDependentResources sets the optional parameter "ignoreDependentResources": This field allows this CA to be deleted even if it's being depended on by another resource. However, doing so may result in unintended and unrecoverable effects on any dependent resources since the CA will no longer be able to issue certificates.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDeleteCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDeleteCall) SkipGracePeriod added in v0.71.0

SkipGracePeriod sets the optional parameter "skipGracePeriod": If this flag is set, the Certificate Authority will be deleted as soon as possible without a 30-day grace period where undeletion would have been allowed. If you proceed, there will be no way to recover this CA.

type ProjectsLocationsCaPoolsCertificateAuthoritiesDisableCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDisableCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDisableCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDisableCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesDisableCall) Header

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesEnableCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesEnableCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesEnableCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesEnableCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesEnableCall) Header

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesFetchCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesFetchCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesFetchCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesFetchCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesFetchCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesFetchCall) IfNoneMatch

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesGetCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesGetCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesGetCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesGetCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesGetCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesGetCall) IfNoneMatch

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

type ProjectsLocationsCaPoolsCertificateAuthoritiesListCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) Filter

Filter sets the optional parameter "filter": Only include resources that match the filter in the response.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) IfNoneMatch

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of CertificateAuthorities to include in the response. Further CertificateAuthorities can subsequently be obtained by including the ListCertificateAuthoritiesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) PageToken

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesListCall) 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.

type ProjectsLocationsCaPoolsCertificateAuthoritiesPatchCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesPatchCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesPatchCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesPatchCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesPatchCall) Header

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesPatchCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A list of fields to be updated in this request.

type ProjectsLocationsCaPoolsCertificateAuthoritiesService

type ProjectsLocationsCaPoolsCertificateAuthoritiesService struct {
	CertificateRevocationLists *ProjectsLocationsCaPoolsCertificateAuthoritiesCertificateRevocationListsService
	// contains filtered or unexported fields
}

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) Activate

Activate: Activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.

  • name: The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) Create

Create: Create a new CertificateAuthority in a given Project and Location.

  • parent: The resource name of the CaPool associated with the CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) Delete

Delete: Delete a CertificateAuthority.

  • name: The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) Disable

Disable: Disable a CertificateAuthority.

  • name: The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) Enable

Enable: Enable a CertificateAuthority.

  • name: The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) Fetch

Fetch: Fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.

  • name: The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) Get

Get: Returns a CertificateAuthority.

- name: The name of the CertificateAuthority to get.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) List

List: Lists CertificateAuthorities.

  • parent: The resource name of the CaPool associated with the CertificateAuthorities, in the format `projects/*/locations/*/caPools/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) Patch

Patch: Update a CertificateAuthority.

  • name: Output only. Identifier. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesService) Undelete

Undelete: Undelete a CertificateAuthority that has been deleted.

  • name: The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.

type ProjectsLocationsCaPoolsCertificateAuthoritiesUndeleteCall

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesUndeleteCall) Context

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesUndeleteCall) Do

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesUndeleteCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificateAuthoritiesUndeleteCall) Header

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

type ProjectsLocationsCaPoolsCertificatesCreateCall

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

func (*ProjectsLocationsCaPoolsCertificatesCreateCall) CertificateId

CertificateId sets the optional parameter "certificateId": It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a CertificateAuthority in the Enterprise CertificateAuthority.tier, but is optional and its value is ignored otherwise.

func (*ProjectsLocationsCaPoolsCertificatesCreateCall) Context

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

func (*ProjectsLocationsCaPoolsCertificatesCreateCall) Do

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

func (*ProjectsLocationsCaPoolsCertificatesCreateCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificatesCreateCall) Header

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

func (*ProjectsLocationsCaPoolsCertificatesCreateCall) IssuingCertificateAuthorityId

func (c *ProjectsLocationsCaPoolsCertificatesCreateCall) IssuingCertificateAuthorityId(issuingCertificateAuthorityId string) *ProjectsLocationsCaPoolsCertificatesCreateCall

IssuingCertificateAuthorityId sets the optional parameter "issuingCertificateAuthorityId": The resource ID of the CertificateAuthority that should issue the certificate. This optional field will ignore the load-balancing scheme of the Pool and directly issue the certificate from the CA with the specified ID, contained in the same CaPool referenced by `parent`. Per-CA quota rules apply. If left empty, a CertificateAuthority will be chosen from the CaPool by the service. For example, to issue a Certificate from a Certificate Authority with resource name "projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthori ties/my-ca", you can set the parent to "projects/my-project/locations/us-central1/caPools/my-pool" and the issuing_certificate_authority_id to "my-ca".

func (*ProjectsLocationsCaPoolsCertificatesCreateCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsCaPoolsCertificatesCreateCall) ValidateOnly

ValidateOnly sets the optional parameter "validateOnly": If this is true, no Certificate resource will be persisted regardless of the CaPool's tier, and the returned Certificate will not contain the pem_certificate field.

type ProjectsLocationsCaPoolsCertificatesGetCall

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

func (*ProjectsLocationsCaPoolsCertificatesGetCall) Context

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

func (*ProjectsLocationsCaPoolsCertificatesGetCall) Do

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

func (*ProjectsLocationsCaPoolsCertificatesGetCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificatesGetCall) Header

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

func (*ProjectsLocationsCaPoolsCertificatesGetCall) IfNoneMatch

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

type ProjectsLocationsCaPoolsCertificatesListCall

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

func (*ProjectsLocationsCaPoolsCertificatesListCall) Context

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

func (*ProjectsLocationsCaPoolsCertificatesListCall) Do

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

func (*ProjectsLocationsCaPoolsCertificatesListCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificatesListCall) Filter

Filter sets the optional parameter "filter": Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation (https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#filtering_support).

func (*ProjectsLocationsCaPoolsCertificatesListCall) Header

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

func (*ProjectsLocationsCaPoolsCertificatesListCall) IfNoneMatch

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

func (*ProjectsLocationsCaPoolsCertificatesListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation (https://cloud.google.com/certificate-authority-service/docs/sorting-filtering-certificates#sorting_support).

func (*ProjectsLocationsCaPoolsCertificatesListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

func (*ProjectsLocationsCaPoolsCertificatesListCall) PageToken

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

func (*ProjectsLocationsCaPoolsCertificatesListCall) 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.

type ProjectsLocationsCaPoolsCertificatesPatchCall

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

func (*ProjectsLocationsCaPoolsCertificatesPatchCall) Context

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

func (*ProjectsLocationsCaPoolsCertificatesPatchCall) Do

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

func (*ProjectsLocationsCaPoolsCertificatesPatchCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificatesPatchCall) Header

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

func (*ProjectsLocationsCaPoolsCertificatesPatchCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsCaPoolsCertificatesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A list of fields to be updated in this request.

type ProjectsLocationsCaPoolsCertificatesRevokeCall

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

func (*ProjectsLocationsCaPoolsCertificatesRevokeCall) Context

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

func (*ProjectsLocationsCaPoolsCertificatesRevokeCall) Do

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

func (*ProjectsLocationsCaPoolsCertificatesRevokeCall) Fields

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

func (*ProjectsLocationsCaPoolsCertificatesRevokeCall) Header

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

type ProjectsLocationsCaPoolsCertificatesService

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

func NewProjectsLocationsCaPoolsCertificatesService

func NewProjectsLocationsCaPoolsCertificatesService(s *Service) *ProjectsLocationsCaPoolsCertificatesService

func (*ProjectsLocationsCaPoolsCertificatesService) Create

Create: Create a new Certificate in a given Project, Location from a particular CaPool.

  • parent: The resource name of the CaPool associated with the Certificate, in the format `projects/*/locations/*/caPools/*`.

func (*ProjectsLocationsCaPoolsCertificatesService) Get

Get: Returns a Certificate.

- name: The name of the Certificate to get.

func (*ProjectsLocationsCaPoolsCertificatesService) List

List: Lists Certificates.

  • parent: The resource name of the location associated with the Certificates, in the format `projects/*/locations/*/caPools/*`.

func (*ProjectsLocationsCaPoolsCertificatesService) Patch

Patch: Update a Certificate. Currently, the only field you can update is the labels field.

  • name: Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.

func (*ProjectsLocationsCaPoolsCertificatesService) Revoke

Revoke: Revoke a Certificate.

  • name: The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`.

type ProjectsLocationsCaPoolsCreateCall

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

func (*ProjectsLocationsCaPoolsCreateCall) CaPoolId

CaPoolId sets the optional parameter "caPoolId": Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`

func (*ProjectsLocationsCaPoolsCreateCall) Context

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

func (*ProjectsLocationsCaPoolsCreateCall) Do

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

func (*ProjectsLocationsCaPoolsCreateCall) Fields

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

func (*ProjectsLocationsCaPoolsCreateCall) Header

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

func (*ProjectsLocationsCaPoolsCreateCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsCaPoolsDeleteCall

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

func (*ProjectsLocationsCaPoolsDeleteCall) Context

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

func (*ProjectsLocationsCaPoolsDeleteCall) Do

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

func (*ProjectsLocationsCaPoolsDeleteCall) Fields

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

func (*ProjectsLocationsCaPoolsDeleteCall) Header

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

func (*ProjectsLocationsCaPoolsDeleteCall) IgnoreDependentResources added in v0.117.0

func (c *ProjectsLocationsCaPoolsDeleteCall) IgnoreDependentResources(ignoreDependentResources bool) *ProjectsLocationsCaPoolsDeleteCall

IgnoreDependentResources sets the optional parameter "ignoreDependentResources": This field allows this pool to be deleted even if it's being depended on by another resource. However, doing so may result in unintended and unrecoverable effects on any dependent resources since the pool will no longer be able to issue certificates.

func (*ProjectsLocationsCaPoolsDeleteCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsCaPoolsFetchCaCertsCall

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

func (*ProjectsLocationsCaPoolsFetchCaCertsCall) Context

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

func (*ProjectsLocationsCaPoolsFetchCaCertsCall) Do

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

func (*ProjectsLocationsCaPoolsFetchCaCertsCall) Fields

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

func (*ProjectsLocationsCaPoolsFetchCaCertsCall) Header

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

type ProjectsLocationsCaPoolsGetCall

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

func (*ProjectsLocationsCaPoolsGetCall) Context

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

func (*ProjectsLocationsCaPoolsGetCall) Do

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

func (*ProjectsLocationsCaPoolsGetCall) Fields

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

func (*ProjectsLocationsCaPoolsGetCall) Header

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

func (*ProjectsLocationsCaPoolsGetCall) IfNoneMatch

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

type ProjectsLocationsCaPoolsGetIamPolicyCall

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

func (*ProjectsLocationsCaPoolsGetIamPolicyCall) Context

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

func (*ProjectsLocationsCaPoolsGetIamPolicyCall) Do

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

func (*ProjectsLocationsCaPoolsGetIamPolicyCall) Fields

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

func (*ProjectsLocationsCaPoolsGetIamPolicyCall) Header

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

func (*ProjectsLocationsCaPoolsGetIamPolicyCall) IfNoneMatch

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

func (*ProjectsLocationsCaPoolsGetIamPolicyCall) OptionsRequestedPolicyVersion

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

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

type ProjectsLocationsCaPoolsListCall

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

func (*ProjectsLocationsCaPoolsListCall) Context

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

func (*ProjectsLocationsCaPoolsListCall) Do

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

func (*ProjectsLocationsCaPoolsListCall) Fields

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

func (*ProjectsLocationsCaPoolsListCall) Filter

Filter sets the optional parameter "filter": Only include resources that match the filter in the response.

func (*ProjectsLocationsCaPoolsListCall) Header

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

func (*ProjectsLocationsCaPoolsListCall) IfNoneMatch

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

func (*ProjectsLocationsCaPoolsListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted.

func (*ProjectsLocationsCaPoolsListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

func (*ProjectsLocationsCaPoolsListCall) PageToken

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

func (*ProjectsLocationsCaPoolsListCall) 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.

type ProjectsLocationsCaPoolsPatchCall

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

func (*ProjectsLocationsCaPoolsPatchCall) Context

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

func (*ProjectsLocationsCaPoolsPatchCall) Do

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

func (*ProjectsLocationsCaPoolsPatchCall) Fields

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

func (*ProjectsLocationsCaPoolsPatchCall) Header

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

func (*ProjectsLocationsCaPoolsPatchCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsCaPoolsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A list of fields to be updated in this request.

type ProjectsLocationsCaPoolsService

type ProjectsLocationsCaPoolsService struct {
	CertificateAuthorities *ProjectsLocationsCaPoolsCertificateAuthoritiesService

	Certificates *ProjectsLocationsCaPoolsCertificatesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsCaPoolsService

func NewProjectsLocationsCaPoolsService(s *Service) *ProjectsLocationsCaPoolsService

func (*ProjectsLocationsCaPoolsService) Create

Create: Create a CaPool.

  • parent: The resource name of the location associated with the CaPool, in the format `projects/*/locations/*`.

func (*ProjectsLocationsCaPoolsService) Delete

Delete: Delete a CaPool.

  • name: The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`.

func (*ProjectsLocationsCaPoolsService) FetchCaCerts

FetchCaCerts: FetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all certificate authorities in the ENABLED, DISABLED, or STAGED states.

  • caPool: The resource name for the CaPool in the format `projects/*/locations/*/caPools/*`.

func (*ProjectsLocationsCaPoolsService) Get

Get: Returns a CaPool.

- name: The name of the CaPool to get.

func (*ProjectsLocationsCaPoolsService) GetIamPolicy

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

func (*ProjectsLocationsCaPoolsService) List

List: Lists CaPools.

  • parent: The resource name of the location associated with the CaPools, in the format `projects/*/locations/*`.

func (*ProjectsLocationsCaPoolsService) Patch

Patch: Update a CaPool.

  • name: Output only. Identifier. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`.

func (*ProjectsLocationsCaPoolsService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsCaPoolsService) TestIamPermissions

func (r *ProjectsLocationsCaPoolsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsCaPoolsTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsCaPoolsSetIamPolicyCall

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

func (*ProjectsLocationsCaPoolsSetIamPolicyCall) Context

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

func (*ProjectsLocationsCaPoolsSetIamPolicyCall) Do

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

func (*ProjectsLocationsCaPoolsSetIamPolicyCall) Fields

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

func (*ProjectsLocationsCaPoolsSetIamPolicyCall) Header

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

type ProjectsLocationsCaPoolsTestIamPermissionsCall

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

func (*ProjectsLocationsCaPoolsTestIamPermissionsCall) Context

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

func (*ProjectsLocationsCaPoolsTestIamPermissionsCall) Do

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

func (*ProjectsLocationsCaPoolsTestIamPermissionsCall) Fields

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

func (*ProjectsLocationsCaPoolsTestIamPermissionsCall) Header

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

type ProjectsLocationsCertificateTemplatesCreateCall

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

func (*ProjectsLocationsCertificateTemplatesCreateCall) CertificateTemplateId

CertificateTemplateId sets the optional parameter "certificateTemplateId": Required. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`

func (*ProjectsLocationsCertificateTemplatesCreateCall) Context

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

func (*ProjectsLocationsCertificateTemplatesCreateCall) Do

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

func (*ProjectsLocationsCertificateTemplatesCreateCall) Fields

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

func (*ProjectsLocationsCertificateTemplatesCreateCall) Header

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

func (*ProjectsLocationsCertificateTemplatesCreateCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsCertificateTemplatesDeleteCall

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

func (*ProjectsLocationsCertificateTemplatesDeleteCall) Context

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

func (*ProjectsLocationsCertificateTemplatesDeleteCall) Do

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

func (*ProjectsLocationsCertificateTemplatesDeleteCall) Fields

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

func (*ProjectsLocationsCertificateTemplatesDeleteCall) Header

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

func (*ProjectsLocationsCertificateTemplatesDeleteCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

type ProjectsLocationsCertificateTemplatesGetCall

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

func (*ProjectsLocationsCertificateTemplatesGetCall) Context

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

func (*ProjectsLocationsCertificateTemplatesGetCall) Do

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

func (*ProjectsLocationsCertificateTemplatesGetCall) Fields

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

func (*ProjectsLocationsCertificateTemplatesGetCall) Header

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

func (*ProjectsLocationsCertificateTemplatesGetCall) IfNoneMatch

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

type ProjectsLocationsCertificateTemplatesGetIamPolicyCall

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

func (*ProjectsLocationsCertificateTemplatesGetIamPolicyCall) Context

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

func (*ProjectsLocationsCertificateTemplatesGetIamPolicyCall) Do

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

func (*ProjectsLocationsCertificateTemplatesGetIamPolicyCall) Fields

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

func (*ProjectsLocationsCertificateTemplatesGetIamPolicyCall) Header

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

func (*ProjectsLocationsCertificateTemplatesGetIamPolicyCall) IfNoneMatch

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

func (*ProjectsLocationsCertificateTemplatesGetIamPolicyCall) OptionsRequestedPolicyVersion

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

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

type ProjectsLocationsCertificateTemplatesListCall

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

func (*ProjectsLocationsCertificateTemplatesListCall) Context

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

func (*ProjectsLocationsCertificateTemplatesListCall) Do

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

func (*ProjectsLocationsCertificateTemplatesListCall) Fields

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

func (*ProjectsLocationsCertificateTemplatesListCall) Filter

Filter sets the optional parameter "filter": Only include resources that match the filter in the response.

func (*ProjectsLocationsCertificateTemplatesListCall) Header

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

func (*ProjectsLocationsCertificateTemplatesListCall) IfNoneMatch

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

func (*ProjectsLocationsCertificateTemplatesListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted.

func (*ProjectsLocationsCertificateTemplatesListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of CertificateTemplates to include in the response. Further CertificateTemplates can subsequently be obtained by including the ListCertificateTemplatesResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

func (*ProjectsLocationsCertificateTemplatesListCall) PageToken

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

func (*ProjectsLocationsCertificateTemplatesListCall) 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.

type ProjectsLocationsCertificateTemplatesPatchCall

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

func (*ProjectsLocationsCertificateTemplatesPatchCall) Context

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

func (*ProjectsLocationsCertificateTemplatesPatchCall) Do

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

func (*ProjectsLocationsCertificateTemplatesPatchCall) Fields

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

func (*ProjectsLocationsCertificateTemplatesPatchCall) Header

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

func (*ProjectsLocationsCertificateTemplatesPatchCall) RequestId

RequestId sets the optional parameter "requestId": An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

func (*ProjectsLocationsCertificateTemplatesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A list of fields to be updated in this request.

type ProjectsLocationsCertificateTemplatesService

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

func NewProjectsLocationsCertificateTemplatesService

func NewProjectsLocationsCertificateTemplatesService(s *Service) *ProjectsLocationsCertificateTemplatesService

func (*ProjectsLocationsCertificateTemplatesService) Create

Create: Create a new CertificateTemplate in a given Project and Location.

  • parent: The resource name of the location associated with the CertificateTemplate, in the format `projects/*/locations/*`.

func (*ProjectsLocationsCertificateTemplatesService) Delete

Delete: DeleteCertificateTemplate deletes a CertificateTemplate.

  • name: The resource name for this CertificateTemplate in the format `projects/*/locations/*/certificateTemplates/*`.

func (*ProjectsLocationsCertificateTemplatesService) Get

Get: Returns a CertificateTemplate.

- name: The name of the CertificateTemplate to get.

func (*ProjectsLocationsCertificateTemplatesService) GetIamPolicy

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

func (*ProjectsLocationsCertificateTemplatesService) List

List: Lists CertificateTemplates.

  • parent: The resource name of the location associated with the CertificateTemplates, in the format `projects/*/locations/*`.

func (*ProjectsLocationsCertificateTemplatesService) Patch

Patch: Update a CertificateTemplate.

  • name: Output only. The resource name for this CertificateTemplate in the format `projects/*/locations/*/certificateTemplates/*`.

func (*ProjectsLocationsCertificateTemplatesService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

func (*ProjectsLocationsCertificateTemplatesService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsLocationsCertificateTemplatesSetIamPolicyCall

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

func (*ProjectsLocationsCertificateTemplatesSetIamPolicyCall) Context

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

func (*ProjectsLocationsCertificateTemplatesSetIamPolicyCall) Do

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

func (*ProjectsLocationsCertificateTemplatesSetIamPolicyCall) Fields

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

func (*ProjectsLocationsCertificateTemplatesSetIamPolicyCall) Header

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

type ProjectsLocationsCertificateTemplatesTestIamPermissionsCall

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

func (*ProjectsLocationsCertificateTemplatesTestIamPermissionsCall) Context

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

func (*ProjectsLocationsCertificateTemplatesTestIamPermissionsCall) Do

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

func (*ProjectsLocationsCertificateTemplatesTestIamPermissionsCall) Fields

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

func (*ProjectsLocationsCertificateTemplatesTestIamPermissionsCall) Header

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

type ProjectsLocationsGetCall

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

func (*ProjectsLocationsGetCall) Fields

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

func (*ProjectsLocationsGetCall) Header

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

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

func (*ProjectsLocationsGetCall) IfNoneMatch

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

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

type ProjectsLocationsListCall

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

func (*ProjectsLocationsListCall) Context

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

func (*ProjectsLocationsListCall) Do

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

func (*ProjectsLocationsListCall) Fields

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

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header

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

func (*ProjectsLocationsListCall) IfNoneMatch

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

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

func (*ProjectsLocationsListCall) PageSize

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

func (*ProjectsLocationsListCall) PageToken

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

func (*ProjectsLocationsListCall) Pages

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

type ProjectsLocationsOperationsCancelCall

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

func (*ProjectsLocationsOperationsCancelCall) Context

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

func (*ProjectsLocationsOperationsCancelCall) Do

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

func (*ProjectsLocationsOperationsCancelCall) Fields

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

func (*ProjectsLocationsOperationsCancelCall) Header

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

type ProjectsLocationsOperationsDeleteCall

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

func (*ProjectsLocationsOperationsDeleteCall) Context

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

func (*ProjectsLocationsOperationsDeleteCall) Do

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

func (*ProjectsLocationsOperationsDeleteCall) Fields

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

func (*ProjectsLocationsOperationsDeleteCall) Header

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

type ProjectsLocationsOperationsGetCall

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

func (*ProjectsLocationsOperationsGetCall) Context

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

func (*ProjectsLocationsOperationsGetCall) Do

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

func (*ProjectsLocationsOperationsGetCall) Fields

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

func (*ProjectsLocationsOperationsGetCall) Header

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

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch

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

type ProjectsLocationsOperationsListCall

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

func (*ProjectsLocationsOperationsListCall) Context

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

func (*ProjectsLocationsOperationsListCall) Do

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

func (*ProjectsLocationsOperationsListCall) Fields

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

func (*ProjectsLocationsOperationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsOperationsListCall) Header

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

func (*ProjectsLocationsOperationsListCall) IfNoneMatch

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

func (*ProjectsLocationsOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsOperationsListCall) 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.

type ProjectsLocationsOperationsService

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

func NewProjectsLocationsOperationsService

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Cancel

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsOperationsService) Delete

Delete: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.

- name: The name of the operation resource to be deleted.

func (*ProjectsLocationsOperationsService) Get

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsLocationsOperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

- name: The name of the operation's parent resource.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	CaPools *ProjectsLocationsCaPoolsService

	CertificateTemplates *ProjectsLocationsCertificateTemplatesService

	Operations *ProjectsLocationsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

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.

type ProjectsService

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

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type PublicKey

type PublicKey struct {
	// Format: Required. The format of the public key.
	//
	// Possible values:
	//   "KEY_FORMAT_UNSPECIFIED" - Default unspecified value.
	//   "PEM" - The key is PEM-encoded as defined in [RFC
	// 7468](https://tools.ietf.org/html/rfc7468). It can be any of the following:
	// a PEM-encoded PKCS#1/RFC 3447 RSAPublicKey structure, an RFC 5280
	// [SubjectPublicKeyInfo](https://tools.ietf.org/html/rfc5280#section-4.1) or a
	// PEM-encoded X.509 certificate signing request (CSR). If a
	// [SubjectPublicKeyInfo](https://tools.ietf.org/html/rfc5280#section-4.1) is
	// specified, it can contain a A PEM-encoded PKCS#1/RFC 3447 RSAPublicKey or a
	// NIST P-256/secp256r1/prime256v1 or P-384 key. If a CSR is specified, it will
	// used solely for the purpose of extracting the public key. When generated by
	// the service, it will always be an RFC 5280
	// [SubjectPublicKeyInfo](https://tools.ietf.org/html/rfc5280#section-4.1)
	// structure containing an algorithm identifier and a key.
	Format string `json:"format,omitempty"`
	// Key: Required. A public key. The padding and encoding must match with the
	// `KeyFormat` value specified for the `format` field.
	Key string `json:"key,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Format") 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. "Format") 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:"-"`
}

PublicKey: A PublicKey describes a public key.

func (PublicKey) MarshalJSON

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

type PublishingOptions

type PublishingOptions struct {
	// EncodingFormat: Optional. Specifies the encoding format of each
	// CertificateAuthority resource's CA certificate and CRLs. If this is omitted,
	// CA certificates and CRLs will be published in PEM.
	//
	// Possible values:
	//   "ENCODING_FORMAT_UNSPECIFIED" - Not specified. By default, PEM format will
	// be used.
	//   "PEM" - The CertificateAuthority's CA certificate and CRLs will be
	// published in PEM format.
	//   "DER" - The CertificateAuthority's CA certificate and CRLs will be
	// published in DER format.
	EncodingFormat string `json:"encodingFormat,omitempty"`
	// PublishCaCert: Optional. When true, publishes each CertificateAuthority's CA
	// certificate and includes its URL in the "Authority Information Access" X.509
	// extension in all issued Certificates. If this is false, the CA certificate
	// will not be published and the corresponding X.509 extension will not be
	// written in issued certificates.
	PublishCaCert bool `json:"publishCaCert,omitempty"`
	// PublishCrl: Optional. When true, publishes each CertificateAuthority's CRL
	// and includes its URL in the "CRL Distribution Points" X.509 extension in all
	// issued Certificates. If this is false, CRLs will not be published and the
	// corresponding X.509 extension will not be written in issued certificates.
	// CRLs will expire 7 days from their creation. However, we will rebuild daily.
	// CRLs are also rebuilt shortly after a certificate is revoked.
	PublishCrl bool `json:"publishCrl,omitempty"`
	// ForceSendFields is a list of field names (e.g. "EncodingFormat") 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. "EncodingFormat") 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:"-"`
}

PublishingOptions: Options relating to the publication of each CertificateAuthority's CA certificate and CRLs and their inclusion as extensions in issued Certificates. The options set here apply to certificates issued by any CertificateAuthority in the CaPool.

func (PublishingOptions) MarshalJSON

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

type ReconciliationOperationMetadata

type ReconciliationOperationMetadata struct {
	// DeleteResource: DEPRECATED. Use exclusive_action instead.
	DeleteResource bool `json:"deleteResource,omitempty"`
	// ExclusiveAction: Excluisive action returned by the CLH.
	//
	// Possible values:
	//   "UNKNOWN_REPAIR_ACTION" - Unknown repair action.
	//   "DELETE" - The resource has to be deleted. When using this bit, the CLH
	// should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE
	// OperationSignal in SideChannel.
	//   "RETRY" - This resource could not be repaired but the repair should be
	// tried again at a later time. This can happen if there is a dependency that
	// needs to be resolved first- e.g. if a parent resource must be repaired
	// before a child resource.
	ExclusiveAction string `json:"exclusiveAction,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DeleteResource") 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. "DeleteResource") 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:"-"`
}

ReconciliationOperationMetadata: Operation metadata returned by the CLH during resource state reconciliation.

func (ReconciliationOperationMetadata) MarshalJSON

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

type RevocationDetails

type RevocationDetails struct {
	// RevocationState: Indicates why a Certificate was revoked.
	//
	// Possible values:
	//   "REVOCATION_REASON_UNSPECIFIED" - Default unspecified value. This value
	// does indicate that a Certificate has been revoked, but that a reason has not
	// been recorded.
	//   "KEY_COMPROMISE" - Key material for this Certificate may have leaked.
	//   "CERTIFICATE_AUTHORITY_COMPROMISE" - The key material for a certificate
	// authority in the issuing path may have leaked.
	//   "AFFILIATION_CHANGED" - The subject or other attributes in this
	// Certificate have changed.
	//   "SUPERSEDED" - This Certificate has been superseded.
	//   "CESSATION_OF_OPERATION" - This Certificate or entities in the issuing
	// path have ceased to operate.
	//   "CERTIFICATE_HOLD" - This Certificate should not be considered valid, it
	// is expected that it may become valid in the future.
	//   "PRIVILEGE_WITHDRAWN" - This Certificate no longer has permission to
	// assert the listed attributes.
	//   "ATTRIBUTE_AUTHORITY_COMPROMISE" - The authority which determines
	// appropriate attributes for a Certificate may have been compromised.
	RevocationState string `json:"revocationState,omitempty"`
	// RevocationTime: The time at which this Certificate was revoked.
	RevocationTime string `json:"revocationTime,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RevocationState") 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. "RevocationState") 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:"-"`
}

RevocationDetails: Describes fields that are relavent to the revocation of a Certificate.

func (RevocationDetails) MarshalJSON

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

type RevokeCertificateRequest

type RevokeCertificateRequest struct {
	// Reason: Required. The RevocationReason for revoking this certificate.
	//
	// Possible values:
	//   "REVOCATION_REASON_UNSPECIFIED" - Default unspecified value. This value
	// does indicate that a Certificate has been revoked, but that a reason has not
	// been recorded.
	//   "KEY_COMPROMISE" - Key material for this Certificate may have leaked.
	//   "CERTIFICATE_AUTHORITY_COMPROMISE" - The key material for a certificate
	// authority in the issuing path may have leaked.
	//   "AFFILIATION_CHANGED" - The subject or other attributes in this
	// Certificate have changed.
	//   "SUPERSEDED" - This Certificate has been superseded.
	//   "CESSATION_OF_OPERATION" - This Certificate or entities in the issuing
	// path have ceased to operate.
	//   "CERTIFICATE_HOLD" - This Certificate should not be considered valid, it
	// is expected that it may become valid in the future.
	//   "PRIVILEGE_WITHDRAWN" - This Certificate no longer has permission to
	// assert the listed attributes.
	//   "ATTRIBUTE_AUTHORITY_COMPROMISE" - The authority which determines
	// appropriate attributes for a Certificate may have been compromised.
	Reason string `json:"reason,omitempty"`
	// RequestId: Optional. An ID to identify requests. Specify a unique request ID
	// so that if you must retry your request, the server will know to ignore the
	// request if it has already been completed. The server will guarantee that for
	// at least 60 minutes since the first request. For example, consider a
	// situation where you make an initial request and the request times out. If
	// you make the request again with the same request ID, the server can check if
	// original operation with the same request ID was received, and if so, will
	// ignore the second request. This prevents clients from accidentally creating
	// duplicate commitments. The request ID must be a valid UUID with the
	// exception that zero UUID is not supported
	// (00000000-0000-0000-0000-000000000000).
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Reason") 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. "Reason") 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:"-"`
}

RevokeCertificateRequest: Request message for CertificateAuthorityService.RevokeCertificate.

func (RevokeCertificateRequest) MarshalJSON

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

type RevokedCertificate

type RevokedCertificate struct {
	// Certificate: The resource name for the Certificate in the format
	// `projects/*/locations/*/caPools/*/certificates/*`.
	Certificate string `json:"certificate,omitempty"`
	// HexSerialNumber: The serial number of the Certificate.
	HexSerialNumber string `json:"hexSerialNumber,omitempty"`
	// RevocationReason: The reason the Certificate was revoked.
	//
	// Possible values:
	//   "REVOCATION_REASON_UNSPECIFIED" - Default unspecified value. This value
	// does indicate that a Certificate has been revoked, but that a reason has not
	// been recorded.
	//   "KEY_COMPROMISE" - Key material for this Certificate may have leaked.
	//   "CERTIFICATE_AUTHORITY_COMPROMISE" - The key material for a certificate
	// authority in the issuing path may have leaked.
	//   "AFFILIATION_CHANGED" - The subject or other attributes in this
	// Certificate have changed.
	//   "SUPERSEDED" - This Certificate has been superseded.
	//   "CESSATION_OF_OPERATION" - This Certificate or entities in the issuing
	// path have ceased to operate.
	//   "CERTIFICATE_HOLD" - This Certificate should not be considered valid, it
	// is expected that it may become valid in the future.
	//   "PRIVILEGE_WITHDRAWN" - This Certificate no longer has permission to
	// assert the listed attributes.
	//   "ATTRIBUTE_AUTHORITY_COMPROMISE" - The authority which determines
	// appropriate attributes for a Certificate may have been compromised.
	RevocationReason string `json:"revocationReason,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Certificate") 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. "Certificate") 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:"-"`
}

RevokedCertificate: Describes a revoked Certificate.

func (RevokedCertificate) MarshalJSON

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

type RsaKeyType

type RsaKeyType struct {
	// MaxModulusSize: Optional. The maximum allowed RSA modulus size (inclusive),
	// in bits. If this is not set, or if set to zero, the service will not enforce
	// an explicit upper bound on RSA modulus sizes.
	MaxModulusSize int64 `json:"maxModulusSize,omitempty,string"`
	// MinModulusSize: Optional. The minimum allowed RSA modulus size (inclusive),
	// in bits. If this is not set, or if set to zero, the service-level min RSA
	// modulus size will continue to apply.
	MinModulusSize int64 `json:"minModulusSize,omitempty,string"`
	// ForceSendFields is a list of field names (e.g. "MaxModulusSize") 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. "MaxModulusSize") 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:"-"`
}

RsaKeyType: Describes an RSA key that may be used in a Certificate issued from a CaPool.

func (RsaKeyType) MarshalJSON

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

type Service

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

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

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

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

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

func NewService

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

NewService creates a new Service.

type SetIamPolicyRequest

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

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest) MarshalJSON

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

type Status

type Status struct {
	// Code: The status code, which should be an enum value of google.rpc.Code.
	Code int64 `json:"code,omitempty"`
	// Details: A list of messages that carry the error details. There is a common
	// set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`
	// Message: A developer-facing error message, which should be in English. Any
	// user-facing error message should be localized and sent in the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (Status) MarshalJSON

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

type Subject

type Subject struct {
	// CommonName: The "common name" of the subject.
	CommonName string `json:"commonName,omitempty"`
	// CountryCode: The country code of the subject.
	CountryCode string `json:"countryCode,omitempty"`
	// Locality: The locality or city of the subject.
	Locality string `json:"locality,omitempty"`
	// Organization: The organization of the subject.
	Organization string `json:"organization,omitempty"`
	// OrganizationalUnit: The organizational_unit of the subject.
	OrganizationalUnit string `json:"organizationalUnit,omitempty"`
	// PostalCode: The postal code of the subject.
	PostalCode string `json:"postalCode,omitempty"`
	// Province: The province, territory, or regional state of the subject.
	Province string `json:"province,omitempty"`
	// StreetAddress: The street address of the subject.
	StreetAddress string `json:"streetAddress,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CommonName") 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. "CommonName") 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:"-"`
}

Subject: Subject describes parts of a distinguished name that, in turn, describes the subject of the certificate.

func (Subject) MarshalJSON

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

type SubjectAltNames

type SubjectAltNames struct {
	// CustomSans: Contains additional subject alternative name values. For each
	// custom_san, the `value` field must contain an ASN.1 encoded UTF8String.
	CustomSans []*X509Extension `json:"customSans,omitempty"`
	// DnsNames: Contains only valid, fully-qualified host names.
	DnsNames []string `json:"dnsNames,omitempty"`
	// EmailAddresses: Contains only valid RFC 2822 E-mail addresses.
	EmailAddresses []string `json:"emailAddresses,omitempty"`
	// IpAddresses: Contains only valid 32-bit IPv4 addresses or RFC 4291 IPv6
	// addresses.
	IpAddresses []string `json:"ipAddresses,omitempty"`
	// Uris: Contains only valid RFC 3986 URIs.
	Uris []string `json:"uris,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CustomSans") 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. "CustomSans") 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:"-"`
}

SubjectAltNames: SubjectAltNames corresponds to a more modern way of listing what the asserted identity is in a certificate (i.e., compared to the "common name" in the distinguished name).

func (SubjectAltNames) MarshalJSON

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

type SubjectConfig

type SubjectConfig struct {
	// Subject: Optional. Contains distinguished name fields such as the common
	// name, location and organization.
	Subject *Subject `json:"subject,omitempty"`
	// SubjectAltName: Optional. The subject alternative name fields.
	SubjectAltName *SubjectAltNames `json:"subjectAltName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Subject") 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. "Subject") 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:"-"`
}

SubjectConfig: These values are used to create the distinguished name and subject alternative name fields in an X.509 certificate.

func (SubjectConfig) MarshalJSON

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

type SubjectDescription

type SubjectDescription struct {
	// HexSerialNumber: The serial number encoded in lowercase hexadecimal.
	HexSerialNumber string `json:"hexSerialNumber,omitempty"`
	// Lifetime: For convenience, the actual lifetime of an issued certificate.
	Lifetime string `json:"lifetime,omitempty"`
	// NotAfterTime: The time after which the certificate is expired. Per RFC 5280,
	// the validity period for a certificate is the period of time from
	// not_before_time through not_after_time, inclusive. Corresponds to
	// 'not_before_time' + 'lifetime' - 1 second.
	NotAfterTime string `json:"notAfterTime,omitempty"`
	// NotBeforeTime: The time at which the certificate becomes valid.
	NotBeforeTime string `json:"notBeforeTime,omitempty"`
	// Subject: Contains distinguished name fields such as the common name,
	// location and / organization.
	Subject *Subject `json:"subject,omitempty"`
	// SubjectAltName: The subject alternative name fields.
	SubjectAltName *SubjectAltNames `json:"subjectAltName,omitempty"`
	// ForceSendFields is a list of field names (e.g. "HexSerialNumber") 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. "HexSerialNumber") 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:"-"`
}

SubjectDescription: These values describe fields in an issued X.509 certificate such as the distinguished name, subject alternative names, serial number, and lifetime.

func (SubjectDescription) MarshalJSON

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

type SubordinateConfig

type SubordinateConfig struct {
	// CertificateAuthority: Required. This can refer to a CertificateAuthority
	// that was used to create a subordinate CertificateAuthority. This field is
	// used for information and usability purposes only. The resource name is in
	// the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
	CertificateAuthority string `json:"certificateAuthority,omitempty"`
	// PemIssuerChain: Required. Contains the PEM certificate chain for the issuers
	// of this CertificateAuthority, but not pem certificate for this CA itself.
	PemIssuerChain *SubordinateConfigChain `json:"pemIssuerChain,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CertificateAuthority") 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. "CertificateAuthority") 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:"-"`
}

SubordinateConfig: Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain.

func (SubordinateConfig) MarshalJSON

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

type SubordinateConfigChain

type SubordinateConfigChain struct {
	// PemCertificates: Required. Expected to be in leaf-to-root order according to
	// RFC 5246.
	PemCertificates []string `json:"pemCertificates,omitempty"`
	// ForceSendFields is a list of field names (e.g. "PemCertificates") 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. "PemCertificates") 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:"-"`
}

SubordinateConfigChain: This message describes a subordinate CA's issuer certificate chain. This wrapper exists for compatibility reasons.

func (SubordinateConfigChain) MarshalJSON

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

type TestIamPermissionsRequest

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

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest) MarshalJSON

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

type TestIamPermissionsResponse

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

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

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (TestIamPermissionsResponse) MarshalJSON

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

type UndeleteCertificateAuthorityRequest

type UndeleteCertificateAuthorityRequest struct {
	// RequestId: Optional. An ID to identify requests. Specify a unique request ID
	// so that if you must retry your request, the server will know to ignore the
	// request if it has already been completed. The server will guarantee that for
	// at least 60 minutes since the first request. For example, consider a
	// situation where you make an initial request and the request times out. If
	// you make the request again with the same request ID, the server can check if
	// original operation with the same request ID was received, and if so, will
	// ignore the second request. This prevents clients from accidentally creating
	// duplicate commitments. The request ID must be a valid UUID with the
	// exception that zero UUID is not supported
	// (00000000-0000-0000-0000-000000000000).
	RequestId string `json:"requestId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestId") 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. "RequestId") 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:"-"`
}

UndeleteCertificateAuthorityRequest: Request message for CertificateAuthorityService.UndeleteCertificateAuthority.

func (UndeleteCertificateAuthorityRequest) MarshalJSON

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

type X509Extension

type X509Extension struct {
	// Critical: Optional. Indicates whether or not this extension is critical
	// (i.e., if the client does not know how to handle this extension, the client
	// should consider this to be an error).
	Critical bool `json:"critical,omitempty"`
	// ObjectId: Required. The OID for this X.509 extension.
	ObjectId *ObjectId `json:"objectId,omitempty"`
	// Value: Required. The value of this X.509 extension.
	Value string `json:"value,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Critical") 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. "Critical") 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:"-"`
}

X509Extension: An X509Extension specifies an X.509 extension, which may be used in different parts of X.509 objects like certificates, CSRs, and CRLs.

func (X509Extension) MarshalJSON

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

type X509Parameters

type X509Parameters struct {
	// AdditionalExtensions: Optional. Describes custom X.509 extensions.
	AdditionalExtensions []*X509Extension `json:"additionalExtensions,omitempty"`
	// AiaOcspServers: Optional. Describes Online Certificate Status Protocol
	// (OCSP) endpoint addresses that appear in the "Authority Information Access"
	// extension in the certificate.
	AiaOcspServers []string `json:"aiaOcspServers,omitempty"`
	// CaOptions: Optional. Describes options in this X509Parameters that are
	// relevant in a CA certificate. If not specified, a default basic constraints
	// extension with `is_ca=false` will be added for leaf certificates.
	CaOptions *CaOptions `json:"caOptions,omitempty"`
	// KeyUsage: Optional. Indicates the intended use for keys that correspond to a
	// certificate.
	KeyUsage *KeyUsage `json:"keyUsage,omitempty"`
	// NameConstraints: Optional. Describes the X.509 name constraints extension.
	NameConstraints *NameConstraints `json:"nameConstraints,omitempty"`
	// PolicyIds: Optional. Describes the X.509 certificate policy object
	// identifiers, per https://tools.ietf.org/html/rfc5280#section-4.2.1.4.
	PolicyIds []*ObjectId `json:"policyIds,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AdditionalExtensions") 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. "AdditionalExtensions") 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:"-"`
}

X509Parameters: An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions.

func (X509Parameters) MarshalJSON

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL