Package cloudkms

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

cloudkmsService, err := cloudkms.NewService(ctx, option.WithScopes(cloudkms.CloudkmsScope))

cloudkmsService, err := cloudkms.NewService(ctx, option.WithAPIKey("AIza..."))

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

Constants

OAuth2 scopes used by this API.

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"

    // View and manage your keys and secrets stored in Cloud Key Management Service
    CloudkmsScope = "https://www.googleapis.com/auth/cloudkms"
)

type AsymmetricDecryptRequest ¶

AsymmetricDecryptRequest: Request message for KeyManagementService.AsymmetricDecrypt.

type AsymmetricDecryptRequest struct {
    // Ciphertext: Required. The data encrypted with the named CryptoKeyVersion's
    // public key using OAEP.
    Ciphertext string `json:"ciphertext,omitempty"`
    // CiphertextCrc32c: Optional. An optional CRC32C checksum of the
    // AsymmetricDecryptRequest.ciphertext. If specified, KeyManagementService will
    // verify the integrity of the received AsymmetricDecryptRequest.ciphertext
    // using this checksum. KeyManagementService will report an error if the
    // checksum verification fails. If you receive a checksum error, your client
    // should verify that CRC32C(AsymmetricDecryptRequest.ciphertext) is equal to
    // AsymmetricDecryptRequest.ciphertext_crc32c, and if so, perform a limited
    // number of retries. A persistent mismatch may indicate an issue in your
    // computation of the CRC32C checksum. Note: This field is defined as int64 for
    // reasons of compatibility across different languages. However, it is a
    // non-negative integer, which will never exceed 2^32-1, and can be safely
    // downconverted to uint32 in languages that support this type.
    CiphertextCrc32c int64 `json:"ciphertextCrc32c,omitempty,string"`
    // ForceSendFields is a list of field names (e.g. "Ciphertext") 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. "Ciphertext") 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 (*AsymmetricDecryptRequest) MarshalJSON ¶

func (s *AsymmetricDecryptRequest) MarshalJSON() ([]byte, error)

type AsymmetricDecryptResponse ¶

AsymmetricDecryptResponse: Response message for KeyManagementService.AsymmetricDecrypt.

type AsymmetricDecryptResponse struct {
    // Plaintext: The decrypted data originally encrypted with the matching public
    // key.
    Plaintext string `json:"plaintext,omitempty"`
    // PlaintextCrc32c: Integrity verification field. A CRC32C checksum of the
    // returned AsymmetricDecryptResponse.plaintext. An integrity check of
    // AsymmetricDecryptResponse.plaintext can be performed by computing the CRC32C
    // checksum of AsymmetricDecryptResponse.plaintext and comparing your results
    // to this field. Discard the response in case of non-matching checksum values,
    // and perform a limited number of retries. A persistent mismatch may indicate
    // an issue in your computation of the CRC32C checksum. Note: This field is
    // defined as int64 for reasons of compatibility across different languages.
    // However, it is a non-negative integer, which will never exceed 2^32-1, and
    // can be safely downconverted to uint32 in languages that support this type.
    PlaintextCrc32c int64 `json:"plaintextCrc32c,omitempty,string"`
    // ProtectionLevel: The ProtectionLevel of the CryptoKeyVersion used in
    // decryption.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // VerifiedCiphertextCrc32c: Integrity verification field. A flag indicating
    // whether AsymmetricDecryptRequest.ciphertext_crc32c was received by
    // KeyManagementService and used for the integrity verification of the
    // ciphertext. A false value of this field indicates either that
    // AsymmetricDecryptRequest.ciphertext_crc32c was left unset or that it was not
    // delivered to KeyManagementService. If you've set
    // AsymmetricDecryptRequest.ciphertext_crc32c but this field is still false,
    // discard the response and perform a limited number of retries.
    VerifiedCiphertextCrc32c bool `json:"verifiedCiphertextCrc32c,omitempty"`

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

func (s *AsymmetricDecryptResponse) MarshalJSON() ([]byte, error)

type AsymmetricSignRequest ¶

AsymmetricSignRequest: Request message for KeyManagementService.AsymmetricSign.

type AsymmetricSignRequest struct {
    // Data: Optional. The data to sign. It can't be supplied if
    // AsymmetricSignRequest.digest is supplied.
    Data string `json:"data,omitempty"`
    // DataCrc32c: Optional. An optional CRC32C checksum of the
    // AsymmetricSignRequest.data. If specified, KeyManagementService will verify
    // the integrity of the received AsymmetricSignRequest.data using this
    // checksum. KeyManagementService will report an error if the checksum
    // verification fails. If you receive a checksum error, your client should
    // verify that CRC32C(AsymmetricSignRequest.data) is equal to
    // AsymmetricSignRequest.data_crc32c, and if so, perform a limited number of
    // retries. A persistent mismatch may indicate an issue in your computation of
    // the CRC32C checksum. Note: This field is defined as int64 for reasons of
    // compatibility across different languages. However, it is a non-negative
    // integer, which will never exceed 2^32-1, and can be safely downconverted to
    // uint32 in languages that support this type.
    DataCrc32c int64 `json:"dataCrc32c,omitempty,string"`
    // Digest: Optional. The digest of the data to sign. The digest must be
    // produced with the same digest algorithm as specified by the key version's
    // algorithm. This field may not be supplied if AsymmetricSignRequest.data is
    // supplied.
    Digest *Digest `json:"digest,omitempty"`
    // DigestCrc32c: Optional. An optional CRC32C checksum of the
    // AsymmetricSignRequest.digest. If specified, KeyManagementService will verify
    // the integrity of the received AsymmetricSignRequest.digest using this
    // checksum. KeyManagementService will report an error if the checksum
    // verification fails. If you receive a checksum error, your client should
    // verify that CRC32C(AsymmetricSignRequest.digest) is equal to
    // AsymmetricSignRequest.digest_crc32c, and if so, perform a limited number of
    // retries. A persistent mismatch may indicate an issue in your computation of
    // the CRC32C checksum. Note: This field is defined as int64 for reasons of
    // compatibility across different languages. However, it is a non-negative
    // integer, which will never exceed 2^32-1, and can be safely downconverted to
    // uint32 in languages that support this type.
    DigestCrc32c int64 `json:"digestCrc32c,omitempty,string"`
    // ForceSendFields is a list of field names (e.g. "Data") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Data") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*AsymmetricSignRequest) MarshalJSON ¶

func (s *AsymmetricSignRequest) MarshalJSON() ([]byte, error)

type AsymmetricSignResponse ¶

AsymmetricSignResponse: Response message for KeyManagementService.AsymmetricSign.

type AsymmetricSignResponse struct {
    // Name: The resource name of the CryptoKeyVersion used for signing. Check this
    // field to verify that the intended resource was used for signing.
    Name string `json:"name,omitempty"`
    // ProtectionLevel: The ProtectionLevel of the CryptoKeyVersion used for
    // signing.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // Signature: The created signature.
    Signature string `json:"signature,omitempty"`
    // SignatureCrc32c: Integrity verification field. A CRC32C checksum of the
    // returned AsymmetricSignResponse.signature. An integrity check of
    // AsymmetricSignResponse.signature can be performed by computing the CRC32C
    // checksum of AsymmetricSignResponse.signature and comparing your results to
    // this field. Discard the response in case of non-matching checksum values,
    // and perform a limited number of retries. A persistent mismatch may indicate
    // an issue in your computation of the CRC32C checksum. Note: This field is
    // defined as int64 for reasons of compatibility across different languages.
    // However, it is a non-negative integer, which will never exceed 2^32-1, and
    // can be safely downconverted to uint32 in languages that support this type.
    SignatureCrc32c int64 `json:"signatureCrc32c,omitempty,string"`
    // VerifiedDataCrc32c: Integrity verification field. A flag indicating whether
    // AsymmetricSignRequest.data_crc32c was received by KeyManagementService and
    // used for the integrity verification of the data. A false value of this field
    // indicates either that AsymmetricSignRequest.data_crc32c was left unset or
    // that it was not delivered to KeyManagementService. If you've set
    // AsymmetricSignRequest.data_crc32c but this field is still false, discard the
    // response and perform a limited number of retries.
    VerifiedDataCrc32c bool `json:"verifiedDataCrc32c,omitempty"`
    // VerifiedDigestCrc32c: Integrity verification field. A flag indicating
    // whether AsymmetricSignRequest.digest_crc32c was received by
    // KeyManagementService and used for the integrity verification of the digest.
    // A false value of this field indicates either that
    // AsymmetricSignRequest.digest_crc32c was left unset or that it was not
    // delivered to KeyManagementService. If you've set
    // AsymmetricSignRequest.digest_crc32c but this field is still false, discard
    // the response and perform a limited number of retries.
    VerifiedDigestCrc32c bool `json:"verifiedDigestCrc32c,omitempty"`

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

func (*AsymmetricSignResponse) MarshalJSON ¶

func (s *AsymmetricSignResponse) MarshalJSON() ([]byte, error)

type AuditConfig ¶

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.

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:"-"`
}

func (*AuditConfig) MarshalJSON ¶

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

type AuditLogConfig ¶

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.

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:"-"`
}

func (*AuditLogConfig) MarshalJSON ¶

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

type AutokeyConfig ¶

AutokeyConfig: Cloud KMS Autokey configuration for a folder.

type AutokeyConfig struct {
    // KeyProject: Optional. Name of the key project, e.g. `projects/{PROJECT_ID}`
    // or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new
    // CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller
    // will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key
    // project. Once configured, for Cloud KMS Autokey to function properly, this
    // key project must have the Cloud KMS API activated and the Cloud KMS Service
    // Agent for this key project must be granted the `cloudkms.admin` role (or
    // pertinent permissions). A request with an empty key project field will clear
    // the configuration.
    KeyProject string `json:"keyProject,omitempty"`
    // Name: Identifier. Name of the AutokeyConfig resource, e.g.
    // `folders/{FOLDER_NUMBER}/autokeyConfig`.
    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. "KeyProject") 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. "KeyProject") 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 (*AutokeyConfig) MarshalJSON ¶

func (s *AutokeyConfig) MarshalJSON() ([]byte, error)

type Binding ¶

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

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:"-"`
}

func (*Binding) MarshalJSON ¶

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

type Certificate ¶

Certificate: A Certificate represents an X.509 certificate used to authenticate HTTPS connections to EKM replicas.

type Certificate struct {
    // Issuer: Output only. The issuer distinguished name in RFC 2253 format. Only
    // present if parsed is true.
    Issuer string `json:"issuer,omitempty"`
    // NotAfterTime: Output only. The certificate is not valid after this time.
    // Only present if parsed is true.
    NotAfterTime string `json:"notAfterTime,omitempty"`
    // NotBeforeTime: Output only. The certificate is not valid before this time.
    // Only present if parsed is true.
    NotBeforeTime string `json:"notBeforeTime,omitempty"`
    // Parsed: Output only. True if the certificate was parsed successfully.
    Parsed bool `json:"parsed,omitempty"`
    // RawDer: Required. The raw certificate bytes in DER format.
    RawDer string `json:"rawDer,omitempty"`
    // SerialNumber: Output only. The certificate serial number as a hex string.
    // Only present if parsed is true.
    SerialNumber string `json:"serialNumber,omitempty"`
    // Sha256Fingerprint: Output only. The SHA-256 certificate fingerprint as a hex
    // string. Only present if parsed is true.
    Sha256Fingerprint string `json:"sha256Fingerprint,omitempty"`
    // Subject: Output only. The subject distinguished name in RFC 2253 format.
    // Only present if parsed is true.
    Subject string `json:"subject,omitempty"`
    // SubjectAlternativeDnsNames: Output only. The subject Alternative DNS names.
    // Only present if parsed is true.
    SubjectAlternativeDnsNames []string `json:"subjectAlternativeDnsNames,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Issuer") 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. "Issuer") 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 (*Certificate) MarshalJSON ¶

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

type CertificateChains ¶

CertificateChains: Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2.

type CertificateChains struct {
    // CaviumCerts: Cavium certificate chain corresponding to the attestation.
    CaviumCerts []string `json:"caviumCerts,omitempty"`
    // GoogleCardCerts: Google card certificate chain corresponding to the
    // attestation.
    GoogleCardCerts []string `json:"googleCardCerts,omitempty"`
    // GooglePartitionCerts: Google partition certificate chain corresponding to
    // the attestation.
    GooglePartitionCerts []string `json:"googlePartitionCerts,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CaviumCerts") 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. "CaviumCerts") 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 (*CertificateChains) MarshalJSON ¶

func (s *CertificateChains) MarshalJSON() ([]byte, error)

type CryptoKey ¶

CryptoKey: A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.

type CryptoKey struct {
    // CreateTime: Output only. The time at which this CryptoKey was created.
    CreateTime string `json:"createTime,omitempty"`
    // CryptoKeyBackend: Immutable. The resource name of the backend environment
    // where the key material for all CryptoKeyVersions associated with this
    // CryptoKey reside and where all related cryptographic operations are
    // performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of
    // EXTERNAL_VPC, with the resource name in the format
    // `projects/*/locations/*/ekmConnections/*`. Note, this list is non-exhaustive
    // and may apply to additional ProtectionLevels in the future.
    CryptoKeyBackend string `json:"cryptoKeyBackend,omitempty"`
    // DestroyScheduledDuration: Immutable. The period of time that versions of
    // this key spend in the DESTROY_SCHEDULED state before transitioning to
    // DESTROYED. If not specified at creation time, the default duration is 24
    // hours.
    DestroyScheduledDuration string `json:"destroyScheduledDuration,omitempty"`
    // ImportOnly: Immutable. Whether this key may contain imported versions only.
    ImportOnly bool `json:"importOnly,omitempty"`
    // Labels: Labels with user-defined metadata. For more information, see
    // Labeling Keys (https://cloud.google.com/kms/docs/labeling-keys).
    Labels map[string]string `json:"labels,omitempty"`
    // Name: Output only. The resource name for this CryptoKey in the format
    // `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
    Name string `json:"name,omitempty"`
    // NextRotationTime: At next_rotation_time, the Key Management Service will
    // automatically: 1. Create a new version of this CryptoKey. 2. Mark the new
    // version as primary. Key rotations performed manually via
    // CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect
    // next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic
    // rotation. For other keys, this field must be omitted.
    NextRotationTime string `json:"nextRotationTime,omitempty"`
    // Primary: Output only. A copy of the "primary" CryptoKeyVersion that will be
    // used by Encrypt when this CryptoKey is given in EncryptRequest.name. The
    // CryptoKey's primary version can be updated via
    // UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a
    // primary. For other keys, this field will be omitted.
    Primary *CryptoKeyVersion `json:"primary,omitempty"`
    // Purpose: Immutable. The immutable purpose of this CryptoKey.
    //
    // Possible values:
    //   "CRYPTO_KEY_PURPOSE_UNSPECIFIED" - Not specified.
    //   "ENCRYPT_DECRYPT" - CryptoKeys with this purpose may be used with Encrypt
    // and Decrypt.
    //   "ASYMMETRIC_SIGN" - CryptoKeys with this purpose may be used with
    // AsymmetricSign and GetPublicKey.
    //   "ASYMMETRIC_DECRYPT" - CryptoKeys with this purpose may be used with
    // AsymmetricDecrypt and GetPublicKey.
    //   "RAW_ENCRYPT_DECRYPT" - CryptoKeys with this purpose may be used with
    // RawEncrypt and RawDecrypt. This purpose is meant to be used for
    // interoperable symmetric encryption and does not support automatic CryptoKey
    // rotation.
    //   "MAC" - CryptoKeys with this purpose may be used with MacSign.
    Purpose string `json:"purpose,omitempty"`
    // RotationPeriod: next_rotation_time will be advanced by this period when the
    // service automatically rotates a key. Must be at least 24 hours and at most
    // 876,000 hours. If rotation_period is set, next_rotation_time must also be
    // set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other
    // keys, this field must be omitted.
    RotationPeriod string `json:"rotationPeriod,omitempty"`
    // VersionTemplate: A template describing settings for new CryptoKeyVersion
    // instances. The properties of new CryptoKeyVersion instances created by
    // either CreateCryptoKeyVersion or auto-rotation are controlled by this
    // template.
    VersionTemplate *CryptoKeyVersionTemplate `json:"versionTemplate,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:"-"`
}

func (*CryptoKey) MarshalJSON ¶

func (s *CryptoKey) MarshalJSON() ([]byte, error)

type CryptoKeyVersion ¶

CryptoKeyVersion: A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.

type CryptoKeyVersion struct {
    // Algorithm: Output only. The CryptoKeyVersionAlgorithm that this
    // CryptoKeyVersion supports.
    //
    // Possible values:
    //   "CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED" - Not specified.
    //   "GOOGLE_SYMMETRIC_ENCRYPTION" - Creates symmetric encryption keys.
    //   "AES_128_GCM" - AES-GCM (Galois Counter Mode) using 128-bit keys.
    //   "AES_256_GCM" - AES-GCM (Galois Counter Mode) using 256-bit keys.
    //   "AES_128_CBC" - AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.
    //   "AES_256_CBC" - AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.
    //   "AES_128_CTR" - AES-CTR (Counter Mode) using 128-bit keys.
    //   "AES_256_CTR" - AES-CTR (Counter Mode) using 256-bit keys.
    //   "RSA_SIGN_PSS_2048_SHA256" - RSASSA-PSS 2048 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_3072_SHA256" - RSASSA-PSS 3072 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_4096_SHA256" - RSASSA-PSS 4096 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_4096_SHA512" - RSASSA-PSS 4096 bit key with a SHA512 digest.
    //   "RSA_SIGN_PKCS1_2048_SHA256" - RSASSA-PKCS1-v1_5 with a 2048 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_3072_SHA256" - RSASSA-PKCS1-v1_5 with a 3072 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_4096_SHA256" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_4096_SHA512" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
    // SHA512 digest.
    //   "RSA_SIGN_RAW_PKCS1_2048" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 2048 bit key.
    //   "RSA_SIGN_RAW_PKCS1_3072" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 3072 bit key.
    //   "RSA_SIGN_RAW_PKCS1_4096" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 4096 bit key.
    //   "RSA_DECRYPT_OAEP_2048_SHA256" - RSAES-OAEP 2048 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_3072_SHA256" - RSAES-OAEP 3072 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA256" - RSAES-OAEP 4096 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA512" - RSAES-OAEP 4096 bit key with a SHA512
    // digest.
    //   "RSA_DECRYPT_OAEP_2048_SHA1" - RSAES-OAEP 2048 bit key with a SHA1 digest.
    //   "RSA_DECRYPT_OAEP_3072_SHA1" - RSAES-OAEP 3072 bit key with a SHA1 digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA1" - RSAES-OAEP 4096 bit key with a SHA1 digest.
    //   "EC_SIGN_P256_SHA256" - ECDSA on the NIST P-256 curve with a SHA256
    // digest. Other hash functions can also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_P384_SHA384" - ECDSA on the NIST P-384 curve with a SHA384
    // digest. Other hash functions can also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_SECP256K1_SHA256" - ECDSA on the non-NIST secp256k1 curve. This
    // curve is only supported for HSM protection level. Other hash functions can
    // also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_ED25519" - EdDSA on the Curve25519 in pure mode (taking data as
    // input).
    //   "HMAC_SHA256" - HMAC-SHA256 signing with a 256 bit key.
    //   "HMAC_SHA1" - HMAC-SHA1 signing with a 160 bit key.
    //   "HMAC_SHA384" - HMAC-SHA384 signing with a 384 bit key.
    //   "HMAC_SHA512" - HMAC-SHA512 signing with a 512 bit key.
    //   "HMAC_SHA224" - HMAC-SHA224 signing with a 224 bit key.
    //   "EXTERNAL_SYMMETRIC_ENCRYPTION" - Algorithm representing symmetric
    // encryption by an external key manager.
    Algorithm string `json:"algorithm,omitempty"`
    // Attestation: Output only. Statement that was generated and signed by the HSM
    // at key creation time. Use this statement to verify attributes of the key as
    // stored on the HSM, independently of Google. Only provided for key versions
    // with protection_level HSM.
    Attestation *KeyOperationAttestation `json:"attestation,omitempty"`
    // CreateTime: Output only. The time at which this CryptoKeyVersion was
    // created.
    CreateTime string `json:"createTime,omitempty"`
    // DestroyEventTime: Output only. The time this CryptoKeyVersion's key material
    // was destroyed. Only present if state is DESTROYED.
    DestroyEventTime string `json:"destroyEventTime,omitempty"`
    // DestroyTime: Output only. The time this CryptoKeyVersion's key material is
    // scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
    DestroyTime string `json:"destroyTime,omitempty"`
    // ExternalDestructionFailureReason: Output only. The root cause of the most
    // recent external destruction failure. Only present if state is
    // EXTERNAL_DESTRUCTION_FAILED.
    ExternalDestructionFailureReason string `json:"externalDestructionFailureReason,omitempty"`
    // ExternalProtectionLevelOptions: ExternalProtectionLevelOptions stores a
    // group of additional fields for configuring a CryptoKeyVersion that are
    // specific to the EXTERNAL protection level and EXTERNAL_VPC protection
    // levels.
    ExternalProtectionLevelOptions *ExternalProtectionLevelOptions `json:"externalProtectionLevelOptions,omitempty"`
    // GenerateTime: Output only. The time this CryptoKeyVersion's key material was
    // generated.
    GenerateTime string `json:"generateTime,omitempty"`
    // GenerationFailureReason: Output only. The root cause of the most recent
    // generation failure. Only present if state is GENERATION_FAILED.
    GenerationFailureReason string `json:"generationFailureReason,omitempty"`
    // ImportFailureReason: Output only. The root cause of the most recent import
    // failure. Only present if state is IMPORT_FAILED.
    ImportFailureReason string `json:"importFailureReason,omitempty"`
    // ImportJob: Output only. The name of the ImportJob used in the most recent
    // import of this CryptoKeyVersion. Only present if the underlying key material
    // was imported.
    ImportJob string `json:"importJob,omitempty"`
    // ImportTime: Output only. The time at which this CryptoKeyVersion's key
    // material was most recently imported.
    ImportTime string `json:"importTime,omitempty"`
    // Name: Output only. The resource name for this CryptoKeyVersion in the format
    // `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
    Name string `json:"name,omitempty"`
    // ProtectionLevel: Output only. The ProtectionLevel describing how crypto
    // operations are performed with this CryptoKeyVersion.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // ReimportEligible: Output only. Whether or not this key version is eligible
    // for reimport, by being specified as a target in
    // ImportCryptoKeyVersionRequest.crypto_key_version.
    ReimportEligible bool `json:"reimportEligible,omitempty"`
    // State: The current state of the CryptoKeyVersion.
    //
    // Possible values:
    //   "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED" - Not specified.
    //   "PENDING_GENERATION" - This version is still being generated. It may not
    // be used, enabled, disabled, or destroyed yet. Cloud KMS will automatically
    // mark this version ENABLED as soon as the version is ready.
    //   "ENABLED" - This version may be used for cryptographic operations.
    //   "DISABLED" - This version may not be used, but the key material is still
    // available, and the version can be placed back into the ENABLED state.
    //   "DESTROYED" - This version is destroyed, and the key material is no longer
    // stored. This version may only become ENABLED again if this version is
    // reimport_eligible and the original key material is reimported with a call to
    // KeyManagementService.ImportCryptoKeyVersion.
    //   "DESTROY_SCHEDULED" - This version is scheduled for destruction, and will
    // be destroyed soon. Call RestoreCryptoKeyVersion to put it back into the
    // DISABLED state.
    //   "PENDING_IMPORT" - This version is still being imported. It may not be
    // used, enabled, disabled, or destroyed yet. Cloud KMS will automatically mark
    // this version ENABLED as soon as the version is ready.
    //   "IMPORT_FAILED" - This version was not imported successfully. It may not
    // be used, enabled, disabled, or destroyed. The submitted key material has
    // been discarded. Additional details can be found in
    // CryptoKeyVersion.import_failure_reason.
    //   "GENERATION_FAILED" - This version was not generated successfully. It may
    // not be used, enabled, disabled, or destroyed. Additional details can be
    // found in CryptoKeyVersion.generation_failure_reason.
    //   "PENDING_EXTERNAL_DESTRUCTION" - This version was destroyed, and it may
    // not be used or enabled again. Cloud KMS is waiting for the corresponding key
    // material residing in an external key manager to be destroyed.
    //   "EXTERNAL_DESTRUCTION_FAILED" - This version was destroyed, and it may not
    // be used or enabled again. However, Cloud KMS could not confirm that the
    // corresponding key material residing in an external key manager was
    // destroyed. Additional details can be found in
    // CryptoKeyVersion.external_destruction_failure_reason.
    State string `json:"state,omitempty"`

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

func (*CryptoKeyVersion) MarshalJSON ¶

func (s *CryptoKeyVersion) MarshalJSON() ([]byte, error)

type CryptoKeyVersionTemplate ¶

CryptoKeyVersionTemplate: A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation.

type CryptoKeyVersionTemplate struct {
    // Algorithm: Required. Algorithm to use when creating a CryptoKeyVersion based
    // on this template. For backwards compatibility, GOOGLE_SYMMETRIC_ENCRYPTION
    // is implied if both this field is omitted and CryptoKey.purpose is
    // ENCRYPT_DECRYPT.
    //
    // Possible values:
    //   "CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED" - Not specified.
    //   "GOOGLE_SYMMETRIC_ENCRYPTION" - Creates symmetric encryption keys.
    //   "AES_128_GCM" - AES-GCM (Galois Counter Mode) using 128-bit keys.
    //   "AES_256_GCM" - AES-GCM (Galois Counter Mode) using 256-bit keys.
    //   "AES_128_CBC" - AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.
    //   "AES_256_CBC" - AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.
    //   "AES_128_CTR" - AES-CTR (Counter Mode) using 128-bit keys.
    //   "AES_256_CTR" - AES-CTR (Counter Mode) using 256-bit keys.
    //   "RSA_SIGN_PSS_2048_SHA256" - RSASSA-PSS 2048 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_3072_SHA256" - RSASSA-PSS 3072 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_4096_SHA256" - RSASSA-PSS 4096 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_4096_SHA512" - RSASSA-PSS 4096 bit key with a SHA512 digest.
    //   "RSA_SIGN_PKCS1_2048_SHA256" - RSASSA-PKCS1-v1_5 with a 2048 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_3072_SHA256" - RSASSA-PKCS1-v1_5 with a 3072 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_4096_SHA256" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_4096_SHA512" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
    // SHA512 digest.
    //   "RSA_SIGN_RAW_PKCS1_2048" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 2048 bit key.
    //   "RSA_SIGN_RAW_PKCS1_3072" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 3072 bit key.
    //   "RSA_SIGN_RAW_PKCS1_4096" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 4096 bit key.
    //   "RSA_DECRYPT_OAEP_2048_SHA256" - RSAES-OAEP 2048 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_3072_SHA256" - RSAES-OAEP 3072 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA256" - RSAES-OAEP 4096 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA512" - RSAES-OAEP 4096 bit key with a SHA512
    // digest.
    //   "RSA_DECRYPT_OAEP_2048_SHA1" - RSAES-OAEP 2048 bit key with a SHA1 digest.
    //   "RSA_DECRYPT_OAEP_3072_SHA1" - RSAES-OAEP 3072 bit key with a SHA1 digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA1" - RSAES-OAEP 4096 bit key with a SHA1 digest.
    //   "EC_SIGN_P256_SHA256" - ECDSA on the NIST P-256 curve with a SHA256
    // digest. Other hash functions can also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_P384_SHA384" - ECDSA on the NIST P-384 curve with a SHA384
    // digest. Other hash functions can also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_SECP256K1_SHA256" - ECDSA on the non-NIST secp256k1 curve. This
    // curve is only supported for HSM protection level. Other hash functions can
    // also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_ED25519" - EdDSA on the Curve25519 in pure mode (taking data as
    // input).
    //   "HMAC_SHA256" - HMAC-SHA256 signing with a 256 bit key.
    //   "HMAC_SHA1" - HMAC-SHA1 signing with a 160 bit key.
    //   "HMAC_SHA384" - HMAC-SHA384 signing with a 384 bit key.
    //   "HMAC_SHA512" - HMAC-SHA512 signing with a 512 bit key.
    //   "HMAC_SHA224" - HMAC-SHA224 signing with a 224 bit key.
    //   "EXTERNAL_SYMMETRIC_ENCRYPTION" - Algorithm representing symmetric
    // encryption by an external key manager.
    Algorithm string `json:"algorithm,omitempty"`
    // ProtectionLevel: ProtectionLevel to use when creating a CryptoKeyVersion
    // based on this template. Immutable. Defaults to SOFTWARE.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,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:"-"`
}

func (*CryptoKeyVersionTemplate) MarshalJSON ¶

func (s *CryptoKeyVersionTemplate) MarshalJSON() ([]byte, error)

type DecryptRequest ¶

DecryptRequest: Request message for KeyManagementService.Decrypt.

type DecryptRequest struct {
    // AdditionalAuthenticatedData: Optional. Optional data that must match the
    // data originally supplied in EncryptRequest.additional_authenticated_data.
    AdditionalAuthenticatedData string `json:"additionalAuthenticatedData,omitempty"`
    // AdditionalAuthenticatedDataCrc32c: Optional. An optional CRC32C checksum of
    // the DecryptRequest.additional_authenticated_data. If specified,
    // KeyManagementService will verify the integrity of the received
    // DecryptRequest.additional_authenticated_data using this checksum.
    // KeyManagementService will report an error if the checksum verification
    // fails. If you receive a checksum error, your client should verify that
    // CRC32C(DecryptRequest.additional_authenticated_data) is equal to
    // DecryptRequest.additional_authenticated_data_crc32c, and if so, perform a
    // limited number of retries. A persistent mismatch may indicate an issue in
    // your computation of the CRC32C checksum. Note: This field is defined as
    // int64 for reasons of compatibility across different languages. However, it
    // is a non-negative integer, which will never exceed 2^32-1, and can be safely
    // downconverted to uint32 in languages that support this type.
    AdditionalAuthenticatedDataCrc32c int64 `json:"additionalAuthenticatedDataCrc32c,omitempty,string"`
    // Ciphertext: Required. The encrypted data originally returned in
    // EncryptResponse.ciphertext.
    Ciphertext string `json:"ciphertext,omitempty"`
    // CiphertextCrc32c: Optional. An optional CRC32C checksum of the
    // DecryptRequest.ciphertext. If specified, KeyManagementService will verify
    // the integrity of the received DecryptRequest.ciphertext using this checksum.
    // KeyManagementService will report an error if the checksum verification
    // fails. If you receive a checksum error, your client should verify that
    // CRC32C(DecryptRequest.ciphertext) is equal to
    // DecryptRequest.ciphertext_crc32c, and if so, perform a limited number of
    // retries. A persistent mismatch may indicate an issue in your computation of
    // the CRC32C checksum. Note: This field is defined as int64 for reasons of
    // compatibility across different languages. However, it is a non-negative
    // integer, which will never exceed 2^32-1, and can be safely downconverted to
    // uint32 in languages that support this type.
    CiphertextCrc32c int64 `json:"ciphertextCrc32c,omitempty,string"`
    // ForceSendFields is a list of field names (e.g.
    // "AdditionalAuthenticatedData") 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. "AdditionalAuthenticatedData") 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 (*DecryptRequest) MarshalJSON ¶

func (s *DecryptRequest) MarshalJSON() ([]byte, error)

type DecryptResponse ¶

DecryptResponse: Response message for KeyManagementService.Decrypt.

type DecryptResponse struct {
    // Plaintext: The decrypted data originally supplied in
    // EncryptRequest.plaintext.
    Plaintext string `json:"plaintext,omitempty"`
    // PlaintextCrc32c: Integrity verification field. A CRC32C checksum of the
    // returned DecryptResponse.plaintext. An integrity check of
    // DecryptResponse.plaintext can be performed by computing the CRC32C checksum
    // of DecryptResponse.plaintext and comparing your results to this field.
    // Discard the response in case of non-matching checksum values, and perform a
    // limited number of retries. A persistent mismatch may indicate an issue in
    // your computation of the CRC32C checksum. Note: receiving this response
    // message indicates that KeyManagementService is able to successfully decrypt
    // the ciphertext. Note: This field is defined as int64 for reasons of
    // compatibility across different languages. However, it is a non-negative
    // integer, which will never exceed 2^32-1, and can be safely downconverted to
    // uint32 in languages that support this type.
    PlaintextCrc32c int64 `json:"plaintextCrc32c,omitempty,string"`
    // ProtectionLevel: The ProtectionLevel of the CryptoKeyVersion used in
    // decryption.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // UsedPrimary: Whether the Decryption was performed using the primary key
    // version.
    UsedPrimary bool `json:"usedPrimary,omitempty"`

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

func (s *DecryptResponse) MarshalJSON() ([]byte, error)

type DestroyCryptoKeyVersionRequest ¶

DestroyCryptoKeyVersionRequest: Request message for KeyManagementService.DestroyCryptoKeyVersion.

type DestroyCryptoKeyVersionRequest struct {
}

type Digest ¶

Digest: A Digest holds a cryptographic message digest.

type Digest struct {
    // Sha256: A message digest produced with the SHA-256 algorithm.
    Sha256 string `json:"sha256,omitempty"`
    // Sha384: A message digest produced with the SHA-384 algorithm.
    Sha384 string `json:"sha384,omitempty"`
    // Sha512: A message digest produced with the SHA-512 algorithm.
    Sha512 string `json:"sha512,omitempty"`
    // ForceSendFields is a list of field names (e.g. "Sha256") 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. "Sha256") 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 (*Digest) MarshalJSON ¶

func (s *Digest) MarshalJSON() ([]byte, error)

type EkmConfig ¶

EkmConfig: An EkmConfig is a singleton resource that represents configuration parameters that apply to all CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC in a given project and location.

type EkmConfig struct {
    // DefaultEkmConnection: Optional. Resource name of the default EkmConnection.
    // Setting this field to the empty string removes the default.
    DefaultEkmConnection string `json:"defaultEkmConnection,omitempty"`
    // Name: Output only. The resource name for the EkmConfig in the format
    // `projects/*/locations/*/ekmConfig`.
    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. "DefaultEkmConnection") 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. "DefaultEkmConnection") 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 (*EkmConfig) MarshalJSON ¶

func (s *EkmConfig) MarshalJSON() ([]byte, error)

type EkmConnection ¶

EkmConnection: An EkmConnection represents an individual EKM connection. It can be used for creating CryptoKeys and CryptoKeyVersions with a ProtectionLevel of EXTERNAL_VPC, as well as performing cryptographic operations using keys created within the EkmConnection.

type EkmConnection struct {
    // CreateTime: Output only. The time at which the EkmConnection was created.
    CreateTime string `json:"createTime,omitempty"`
    // CryptoSpacePath: Optional. Identifies the EKM Crypto Space that this
    // EkmConnection maps to. Note: This field is required if KeyManagementMode is
    // CLOUD_KMS.
    CryptoSpacePath string `json:"cryptoSpacePath,omitempty"`
    // Etag: Optional. Etag of the currently stored EkmConnection.
    Etag string `json:"etag,omitempty"`
    // KeyManagementMode: Optional. Describes who can perform control plane
    // operations on the EKM. If unset, this defaults to MANUAL.
    //
    // Possible values:
    //   "KEY_MANAGEMENT_MODE_UNSPECIFIED" - Not specified.
    //   "MANUAL" - EKM-side key management operations on CryptoKeys created with
    // this EkmConnection must be initiated from the EKM directly and cannot be
    // performed from Cloud KMS. This means that: * When creating a
    // CryptoKeyVersion associated with this EkmConnection, the caller must supply
    // the key path of pre-existing external key material that will be linked to
    // the CryptoKeyVersion. * Destruction of external key material cannot be
    // requested via the Cloud KMS API and must be performed directly in the EKM. *
    // Automatic rotation of key material is not supported.
    //   "CLOUD_KMS" - All CryptoKeys created with this EkmConnection use EKM-side
    // key management operations initiated from Cloud KMS. This means that: * When
    // a CryptoKeyVersion associated with this EkmConnection is created, the EKM
    // automatically generates new key material and a new key path. The caller
    // cannot supply the key path of pre-existing external key material. *
    // Destruction of external key material associated with this EkmConnection can
    // be requested by calling DestroyCryptoKeyVersion. * Automatic rotation of key
    // material is supported.
    KeyManagementMode string `json:"keyManagementMode,omitempty"`
    // Name: Output only. The resource name for the EkmConnection in the format
    // `projects/*/locations/*/ekmConnections/*`.
    Name string `json:"name,omitempty"`
    // ServiceResolvers: A list of ServiceResolvers where the EKM can be reached.
    // There should be one ServiceResolver per EKM replica. Currently, only a
    // single ServiceResolver is supported.
    ServiceResolvers []*ServiceResolver `json:"serviceResolvers,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:"-"`
}

func (*EkmConnection) MarshalJSON ¶

func (s *EkmConnection) MarshalJSON() ([]byte, error)

type EncryptRequest ¶

EncryptRequest: Request message for KeyManagementService.Encrypt.

type EncryptRequest struct {
    // AdditionalAuthenticatedData: Optional. Optional data that, if specified,
    // must also be provided during decryption through
    // DecryptRequest.additional_authenticated_data. The maximum size depends on
    // the key version's protection_level. For SOFTWARE, EXTERNAL, and EXTERNAL_VPC
    // keys the AAD must be no larger than 64KiB. For HSM keys, the combined length
    // of the plaintext and additional_authenticated_data fields must be no larger
    // than 8KiB.
    AdditionalAuthenticatedData string `json:"additionalAuthenticatedData,omitempty"`
    // AdditionalAuthenticatedDataCrc32c: Optional. An optional CRC32C checksum of
    // the EncryptRequest.additional_authenticated_data. If specified,
    // KeyManagementService will verify the integrity of the received
    // EncryptRequest.additional_authenticated_data using this checksum.
    // KeyManagementService will report an error if the checksum verification
    // fails. If you receive a checksum error, your client should verify that
    // CRC32C(EncryptRequest.additional_authenticated_data) is equal to
    // EncryptRequest.additional_authenticated_data_crc32c, and if so, perform a
    // limited number of retries. A persistent mismatch may indicate an issue in
    // your computation of the CRC32C checksum. Note: This field is defined as
    // int64 for reasons of compatibility across different languages. However, it
    // is a non-negative integer, which will never exceed 2^32-1, and can be safely
    // downconverted to uint32 in languages that support this type.
    AdditionalAuthenticatedDataCrc32c int64 `json:"additionalAuthenticatedDataCrc32c,omitempty,string"`
    // Plaintext: Required. The data to encrypt. Must be no larger than 64KiB. The
    // maximum size depends on the key version's protection_level. For SOFTWARE,
    // EXTERNAL, and EXTERNAL_VPC keys, the plaintext must be no larger than 64KiB.
    // For HSM keys, the combined length of the plaintext and
    // additional_authenticated_data fields must be no larger than 8KiB.
    Plaintext string `json:"plaintext,omitempty"`
    // PlaintextCrc32c: Optional. An optional CRC32C checksum of the
    // EncryptRequest.plaintext. If specified, KeyManagementService will verify the
    // integrity of the received EncryptRequest.plaintext using this checksum.
    // KeyManagementService will report an error if the checksum verification
    // fails. If you receive a checksum error, your client should verify that
    // CRC32C(EncryptRequest.plaintext) is equal to
    // EncryptRequest.plaintext_crc32c, and if so, perform a limited number of
    // retries. A persistent mismatch may indicate an issue in your computation of
    // the CRC32C checksum. Note: This field is defined as int64 for reasons of
    // compatibility across different languages. However, it is a non-negative
    // integer, which will never exceed 2^32-1, and can be safely downconverted to
    // uint32 in languages that support this type.
    PlaintextCrc32c int64 `json:"plaintextCrc32c,omitempty,string"`
    // ForceSendFields is a list of field names (e.g.
    // "AdditionalAuthenticatedData") 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. "AdditionalAuthenticatedData") 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 (*EncryptRequest) MarshalJSON ¶

func (s *EncryptRequest) MarshalJSON() ([]byte, error)

type EncryptResponse ¶

EncryptResponse: Response message for KeyManagementService.Encrypt.

type EncryptResponse struct {
    // Ciphertext: The encrypted data.
    Ciphertext string `json:"ciphertext,omitempty"`
    // CiphertextCrc32c: Integrity verification field. A CRC32C checksum of the
    // returned EncryptResponse.ciphertext. An integrity check of
    // EncryptResponse.ciphertext can be performed by computing the CRC32C checksum
    // of EncryptResponse.ciphertext and comparing your results to this field.
    // Discard the response in case of non-matching checksum values, and perform a
    // limited number of retries. A persistent mismatch may indicate an issue in
    // your computation of the CRC32C checksum. Note: This field is defined as
    // int64 for reasons of compatibility across different languages. However, it
    // is a non-negative integer, which will never exceed 2^32-1, and can be safely
    // downconverted to uint32 in languages that support this type.
    CiphertextCrc32c int64 `json:"ciphertextCrc32c,omitempty,string"`
    // Name: The resource name of the CryptoKeyVersion used in encryption. Check
    // this field to verify that the intended resource was used for encryption.
    Name string `json:"name,omitempty"`
    // ProtectionLevel: The ProtectionLevel of the CryptoKeyVersion used in
    // encryption.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // VerifiedAdditionalAuthenticatedDataCrc32c: Integrity verification field. A
    // flag indicating whether EncryptRequest.additional_authenticated_data_crc32c
    // was received by KeyManagementService and used for the integrity verification
    // of the AAD. A false value of this field indicates either that
    // EncryptRequest.additional_authenticated_data_crc32c was left unset or that
    // it was not delivered to KeyManagementService. If you've set
    // EncryptRequest.additional_authenticated_data_crc32c but this field is still
    // false, discard the response and perform a limited number of retries.
    VerifiedAdditionalAuthenticatedDataCrc32c bool `json:"verifiedAdditionalAuthenticatedDataCrc32c,omitempty"`
    // VerifiedPlaintextCrc32c: Integrity verification field. A flag indicating
    // whether EncryptRequest.plaintext_crc32c was received by KeyManagementService
    // and used for the integrity verification of the plaintext. A false value of
    // this field indicates either that EncryptRequest.plaintext_crc32c was left
    // unset or that it was not delivered to KeyManagementService. If you've set
    // EncryptRequest.plaintext_crc32c but this field is still false, discard the
    // response and perform a limited number of retries.
    VerifiedPlaintextCrc32c bool `json:"verifiedPlaintextCrc32c,omitempty"`

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

func (s *EncryptResponse) MarshalJSON() ([]byte, error)

type Expr ¶

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.

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:"-"`
}

func (*Expr) MarshalJSON ¶

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

type ExternalProtectionLevelOptions ¶

ExternalProtectionLevelOptions: ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.

type ExternalProtectionLevelOptions struct {
    // EkmConnectionKeyPath: The path to the external key material on the EKM when
    // using EkmConnection e.g., "v0/my/key". Set this field instead of
    // external_key_uri when using an EkmConnection.
    EkmConnectionKeyPath string `json:"ekmConnectionKeyPath,omitempty"`
    // ExternalKeyUri: The URI for an external resource that this CryptoKeyVersion
    // represents.
    ExternalKeyUri string `json:"externalKeyUri,omitempty"`
    // ForceSendFields is a list of field names (e.g. "EkmConnectionKeyPath") 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. "EkmConnectionKeyPath") 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 (*ExternalProtectionLevelOptions) MarshalJSON ¶

func (s *ExternalProtectionLevelOptions) MarshalJSON() ([]byte, error)

type FoldersGetAutokeyConfigCall ¶

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

func (*FoldersGetAutokeyConfigCall) Context ¶

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

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

func (*FoldersGetAutokeyConfigCall) Do ¶

func (c *FoldersGetAutokeyConfigCall) Do(opts ...googleapi.CallOption) (*AutokeyConfig, error)

Do executes the "cloudkms.folders.getAutokeyConfig" call. Any non-2xx status code is an error. Response headers are in either *AutokeyConfig.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 (*FoldersGetAutokeyConfigCall) Fields ¶

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

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

func (*FoldersGetAutokeyConfigCall) Header ¶

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

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

func (*FoldersGetAutokeyConfigCall) IfNoneMatch ¶

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

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 FoldersService ¶

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

func NewFoldersService ¶

func NewFoldersService(s *Service) *FoldersService

func (*FoldersService) GetAutokeyConfig ¶

func (r *FoldersService) GetAutokeyConfig(name string) *FoldersGetAutokeyConfigCall

GetAutokeyConfig: Returns the AutokeyConfig for a folder.

• name: Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.

func (*FoldersService) UpdateAutokeyConfig ¶

func (r *FoldersService) UpdateAutokeyConfig(name string, autokeyconfig *AutokeyConfig) *FoldersUpdateAutokeyConfigCall

UpdateAutokeyConfig: Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

• name: Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.

type FoldersUpdateAutokeyConfigCall ¶

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

func (*FoldersUpdateAutokeyConfigCall) Context ¶

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

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

func (*FoldersUpdateAutokeyConfigCall) Do ¶

func (c *FoldersUpdateAutokeyConfigCall) Do(opts ...googleapi.CallOption) (*AutokeyConfig, error)

Do executes the "cloudkms.folders.updateAutokeyConfig" call. Any non-2xx status code is an error. Response headers are in either *AutokeyConfig.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 (*FoldersUpdateAutokeyConfigCall) Fields ¶

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

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

func (*FoldersUpdateAutokeyConfigCall) Header ¶

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

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

func (*FoldersUpdateAutokeyConfigCall) UpdateMask ¶

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

UpdateMask sets the optional parameter "updateMask": Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.

type GenerateRandomBytesRequest ¶

GenerateRandomBytesRequest: Request message for KeyManagementService.GenerateRandomBytes.

type GenerateRandomBytesRequest struct {
    // LengthBytes: The length in bytes of the amount of randomness to retrieve.
    // Minimum 8 bytes, maximum 1024 bytes.
    LengthBytes int64 `json:"lengthBytes,omitempty"`
    // ProtectionLevel: The ProtectionLevel to use when generating the random data.
    // Currently, only HSM protection level is supported.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // ForceSendFields is a list of field names (e.g. "LengthBytes") 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. "LengthBytes") 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 (*GenerateRandomBytesRequest) MarshalJSON ¶

func (s *GenerateRandomBytesRequest) MarshalJSON() ([]byte, error)

type GenerateRandomBytesResponse ¶

GenerateRandomBytesResponse: Response message for KeyManagementService.GenerateRandomBytes.

type GenerateRandomBytesResponse struct {
    // Data: The generated data.
    Data string `json:"data,omitempty"`
    // DataCrc32c: Integrity verification field. A CRC32C checksum of the returned
    // GenerateRandomBytesResponse.data. An integrity check of
    // GenerateRandomBytesResponse.data can be performed by computing the CRC32C
    // checksum of GenerateRandomBytesResponse.data and comparing your results to
    // this field. Discard the response in case of non-matching checksum values,
    // and perform a limited number of retries. A persistent mismatch may indicate
    // an issue in your computation of the CRC32C checksum. Note: This field is
    // defined as int64 for reasons of compatibility across different languages.
    // However, it is a non-negative integer, which will never exceed 2^32-1, and
    // can be safely downconverted to uint32 in languages that support this type.
    DataCrc32c int64 `json:"dataCrc32c,omitempty,string"`

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

func (*GenerateRandomBytesResponse) MarshalJSON ¶

func (s *GenerateRandomBytesResponse) MarshalJSON() ([]byte, error)

type ImportCryptoKeyVersionRequest ¶

ImportCryptoKeyVersionRequest: Request message for KeyManagementService.ImportCryptoKeyVersion.

type ImportCryptoKeyVersionRequest struct {
    // Algorithm: Required. The algorithm of the key being imported. This does not
    // need to match the version_template of the CryptoKey this version imports
    // into.
    //
    // Possible values:
    //   "CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED" - Not specified.
    //   "GOOGLE_SYMMETRIC_ENCRYPTION" - Creates symmetric encryption keys.
    //   "AES_128_GCM" - AES-GCM (Galois Counter Mode) using 128-bit keys.
    //   "AES_256_GCM" - AES-GCM (Galois Counter Mode) using 256-bit keys.
    //   "AES_128_CBC" - AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.
    //   "AES_256_CBC" - AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.
    //   "AES_128_CTR" - AES-CTR (Counter Mode) using 128-bit keys.
    //   "AES_256_CTR" - AES-CTR (Counter Mode) using 256-bit keys.
    //   "RSA_SIGN_PSS_2048_SHA256" - RSASSA-PSS 2048 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_3072_SHA256" - RSASSA-PSS 3072 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_4096_SHA256" - RSASSA-PSS 4096 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_4096_SHA512" - RSASSA-PSS 4096 bit key with a SHA512 digest.
    //   "RSA_SIGN_PKCS1_2048_SHA256" - RSASSA-PKCS1-v1_5 with a 2048 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_3072_SHA256" - RSASSA-PKCS1-v1_5 with a 3072 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_4096_SHA256" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_4096_SHA512" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
    // SHA512 digest.
    //   "RSA_SIGN_RAW_PKCS1_2048" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 2048 bit key.
    //   "RSA_SIGN_RAW_PKCS1_3072" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 3072 bit key.
    //   "RSA_SIGN_RAW_PKCS1_4096" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 4096 bit key.
    //   "RSA_DECRYPT_OAEP_2048_SHA256" - RSAES-OAEP 2048 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_3072_SHA256" - RSAES-OAEP 3072 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA256" - RSAES-OAEP 4096 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA512" - RSAES-OAEP 4096 bit key with a SHA512
    // digest.
    //   "RSA_DECRYPT_OAEP_2048_SHA1" - RSAES-OAEP 2048 bit key with a SHA1 digest.
    //   "RSA_DECRYPT_OAEP_3072_SHA1" - RSAES-OAEP 3072 bit key with a SHA1 digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA1" - RSAES-OAEP 4096 bit key with a SHA1 digest.
    //   "EC_SIGN_P256_SHA256" - ECDSA on the NIST P-256 curve with a SHA256
    // digest. Other hash functions can also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_P384_SHA384" - ECDSA on the NIST P-384 curve with a SHA384
    // digest. Other hash functions can also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_SECP256K1_SHA256" - ECDSA on the non-NIST secp256k1 curve. This
    // curve is only supported for HSM protection level. Other hash functions can
    // also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_ED25519" - EdDSA on the Curve25519 in pure mode (taking data as
    // input).
    //   "HMAC_SHA256" - HMAC-SHA256 signing with a 256 bit key.
    //   "HMAC_SHA1" - HMAC-SHA1 signing with a 160 bit key.
    //   "HMAC_SHA384" - HMAC-SHA384 signing with a 384 bit key.
    //   "HMAC_SHA512" - HMAC-SHA512 signing with a 512 bit key.
    //   "HMAC_SHA224" - HMAC-SHA224 signing with a 224 bit key.
    //   "EXTERNAL_SYMMETRIC_ENCRYPTION" - Algorithm representing symmetric
    // encryption by an external key manager.
    Algorithm string `json:"algorithm,omitempty"`
    // CryptoKeyVersion: Optional. The optional name of an existing
    // CryptoKeyVersion to target for an import operation. If this field is not
    // present, a new CryptoKeyVersion containing the supplied key material is
    // created. If this field is present, the supplied key material is imported
    // into the existing CryptoKeyVersion. To import into an existing
    // CryptoKeyVersion, the CryptoKeyVersion must be a child of
    // ImportCryptoKeyVersionRequest.parent, have been previously created via
    // ImportCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key
    // material and algorithm must match the previous CryptoKeyVersion exactly if
    // the CryptoKeyVersion has ever contained key material.
    CryptoKeyVersion string `json:"cryptoKeyVersion,omitempty"`
    // ImportJob: Required. The name of the ImportJob that was used to wrap this
    // key material.
    ImportJob string `json:"importJob,omitempty"`
    // RsaAesWrappedKey: Optional. This field has the same meaning as wrapped_key.
    // Prefer to use that field in new work. Either that field or this field (but
    // not both) must be specified.
    RsaAesWrappedKey string `json:"rsaAesWrappedKey,omitempty"`
    // WrappedKey: Optional. The wrapped key material to import. Before wrapping,
    // key material must be formatted. If importing symmetric key material, the
    // expected key material format is plain bytes. If importing asymmetric key
    // material, the expected key material format is PKCS#8-encoded DER (the
    // PrivateKeyInfo structure from RFC 5208). When wrapping with import methods
    // (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or
    // RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field
    // must contain the concatenation of: 1. An ephemeral AES-256 wrapping key
    // wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with
    // SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported,
    // wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format
    // is the same as the format produced by PKCS#11 mechanism
    // CKM_RSA_AES_KEY_WRAP. When wrapping with import methods
    // (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the
    // formatted key to be imported, wrapped with the public_key using RSAES-OAEP
    // with SHA-256, MGF1 with SHA-256, and an empty label.
    WrappedKey string `json:"wrappedKey,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:"-"`
}

func (*ImportCryptoKeyVersionRequest) MarshalJSON ¶

func (s *ImportCryptoKeyVersionRequest) MarshalJSON() ([]byte, error)

type ImportJob ¶

ImportJob: An ImportJob can be used to create CryptoKeys and CryptoKeyVersions using pre-existing key material, generated outside of Cloud KMS. When an ImportJob is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of import_method. When the wrapping key generation is complete, the state will be set to ACTIVE and the public_key can be fetched. The fetched public key can then be used to wrap your pre-existing key material. Once the key material is wrapped, it can be imported into a new CryptoKeyVersion in an existing CryptoKey by calling ImportCryptoKeyVersion. Multiple CryptoKeyVersions can be imported with a single ImportJob. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key. An ImportJob expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the ImportJob's public key. For more information, see Importing a key (https://cloud.google.com/kms/docs/importing-a-key).

type ImportJob struct {
    // Attestation: Output only. Statement that was generated and signed by the key
    // creator (for example, an HSM) at key creation time. Use this statement to
    // verify attributes of the key as stored on the HSM, independently of Google.
    // Only present if the chosen ImportMethod is one with a protection level of
    // HSM.
    Attestation *KeyOperationAttestation `json:"attestation,omitempty"`
    // CreateTime: Output only. The time at which this ImportJob was created.
    CreateTime string `json:"createTime,omitempty"`
    // ExpireEventTime: Output only. The time this ImportJob expired. Only present
    // if state is EXPIRED.
    ExpireEventTime string `json:"expireEventTime,omitempty"`
    // ExpireTime: Output only. The time at which this ImportJob is scheduled for
    // expiration and can no longer be used to import key material.
    ExpireTime string `json:"expireTime,omitempty"`
    // GenerateTime: Output only. The time this ImportJob's key material was
    // generated.
    GenerateTime string `json:"generateTime,omitempty"`
    // ImportMethod: Required. Immutable. The wrapping method to be used for
    // incoming key material.
    //
    // Possible values:
    //   "IMPORT_METHOD_UNSPECIFIED" - Not specified.
    //   "RSA_OAEP_3072_SHA1_AES_256" - This ImportMethod represents the
    // CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard.
    // In summary, this involves wrapping the raw key with an ephemeral AES key,
    // and wrapping the ephemeral AES key with a 3072 bit RSA key. For more
    // details, see [RSA AES key wrap
    // mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-c
    // urr-v2.40-cos01.html#_Toc408226908).
    //   "RSA_OAEP_4096_SHA1_AES_256" - This ImportMethod represents the
    // CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard.
    // In summary, this involves wrapping the raw key with an ephemeral AES key,
    // and wrapping the ephemeral AES key with a 4096 bit RSA key. For more
    // details, see [RSA AES key wrap
    // mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-c
    // urr-v2.40-cos01.html#_Toc408226908).
    //   "RSA_OAEP_3072_SHA256_AES_256" - This ImportMethod represents the
    // CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard.
    // In summary, this involves wrapping the raw key with an ephemeral AES key,
    // and wrapping the ephemeral AES key with a 3072 bit RSA key. For more
    // details, see [RSA AES key wrap
    // mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-c
    // urr-v2.40-cos01.html#_Toc408226908).
    //   "RSA_OAEP_4096_SHA256_AES_256" - This ImportMethod represents the
    // CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard.
    // In summary, this involves wrapping the raw key with an ephemeral AES key,
    // and wrapping the ephemeral AES key with a 4096 bit RSA key. For more
    // details, see [RSA AES key wrap
    // mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-c
    // urr-v2.40-cos01.html#_Toc408226908).
    //   "RSA_OAEP_3072_SHA256" - This ImportMethod represents RSAES-OAEP with a
    // 3072 bit RSA key. The key material to be imported is wrapped directly with
    // the RSA key. Due to technical limitations of RSA wrapping, this method
    // cannot be used to wrap RSA keys for import.
    //   "RSA_OAEP_4096_SHA256" - This ImportMethod represents RSAES-OAEP with a
    // 4096 bit RSA key. The key material to be imported is wrapped directly with
    // the RSA key. Due to technical limitations of RSA wrapping, this method
    // cannot be used to wrap RSA keys for import.
    ImportMethod string `json:"importMethod,omitempty"`
    // Name: Output only. The resource name for this ImportJob in the format
    // `projects/*/locations/*/keyRings/*/importJobs/*`.
    Name string `json:"name,omitempty"`
    // ProtectionLevel: Required. Immutable. The protection level of the ImportJob.
    // This must match the protection_level of the version_template on the
    // CryptoKey you attempt to import into.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // PublicKey: Output only. The public key with which to wrap key material prior
    // to import. Only returned if state is ACTIVE.
    PublicKey *WrappingPublicKey `json:"publicKey,omitempty"`
    // State: Output only. The current state of the ImportJob, indicating if it can
    // be used.
    //
    // Possible values:
    //   "IMPORT_JOB_STATE_UNSPECIFIED" - Not specified.
    //   "PENDING_GENERATION" - The wrapping key for this job is still being
    // generated. It may not be used. Cloud KMS will automatically mark this job as
    // ACTIVE as soon as the wrapping key is generated.
    //   "ACTIVE" - This job may be used in CreateCryptoKey and
    // CreateCryptoKeyVersion requests.
    //   "EXPIRED" - This job can no longer be used and may not leave this state
    // once entered.
    State string `json:"state,omitempty"`

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

func (s *ImportJob) MarshalJSON() ([]byte, error)

type KeyHandle ¶

KeyHandle: Resource-oriented representation of a request to Cloud KMS Autokey and the resulting provisioning of a CryptoKey.

type KeyHandle struct {
    // KmsKey: Output only. Name of a CryptoKey that has been provisioned for
    // Customer Managed Encryption Key (CMEK) use in the KeyHandle project and
    // location for the requested resource type. The CryptoKey project will reflect
    // the value configured in the AutokeyConfig on the resource project's ancestor
    // folder at the time of the KeyHandle creation. If more than one ancestor
    // folder has a configured AutokeyConfig, the nearest of these configurations
    // is used.
    KmsKey string `json:"kmsKey,omitempty"`
    // Name: Output only. Identifier. Name of the KeyHandle resource, e.g.
    // `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
    Name string `json:"name,omitempty"`
    // ResourceTypeSelector: Required. Indicates the resource type that the
    // resulting CryptoKey is meant to protect, e.g.
    // `{SERVICE}.googleapis.com/{TYPE}`. See documentation for supported resource
    // types.
    ResourceTypeSelector string `json:"resourceTypeSelector,omitempty"`

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

func (s *KeyHandle) MarshalJSON() ([]byte, error)

type KeyOperationAttestation ¶

KeyOperationAttestation: Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key).

type KeyOperationAttestation struct {
    // CertChains: Output only. The certificate chains needed to validate the
    // attestation
    CertChains *CertificateChains `json:"certChains,omitempty"`
    // Content: Output only. The attestation data provided by the HSM when the key
    // operation was performed.
    Content string `json:"content,omitempty"`
    // Format: Output only. The format of the attestation data.
    //
    // Possible values:
    //   "ATTESTATION_FORMAT_UNSPECIFIED" - Not specified.
    //   "CAVIUM_V1_COMPRESSED" - Cavium HSM attestation compressed with gzip. Note
    // that this format is defined by Cavium and subject to change at any time. See
    // https://www.marvell.com/products/security-solutions/nitrox-hs-adapters/software-key-attestation.html.
    //   "CAVIUM_V2_COMPRESSED" - Cavium HSM attestation V2 compressed with gzip.
    // This is a new format introduced in Cavium's version 3.2-08.
    Format string `json:"format,omitempty"`
    // ForceSendFields is a list of field names (e.g. "CertChains") 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. "CertChains") 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 (*KeyOperationAttestation) MarshalJSON ¶

func (s *KeyOperationAttestation) MarshalJSON() ([]byte, error)

type KeyRing ¶

KeyRing: A KeyRing is a toplevel logical grouping of CryptoKeys.

type KeyRing struct {
    // CreateTime: Output only. The time at which this KeyRing was created.
    CreateTime string `json:"createTime,omitempty"`
    // Name: Output only. The resource name for the KeyRing in the format
    // `projects/*/locations/*/keyRings/*`.
    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. "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:"-"`
}

func (*KeyRing) MarshalJSON ¶

func (s *KeyRing) MarshalJSON() ([]byte, error)

type ListCryptoKeyVersionsResponse ¶

ListCryptoKeyVersionsResponse: Response message for KeyManagementService.ListCryptoKeyVersions.

type ListCryptoKeyVersionsResponse struct {
    // CryptoKeyVersions: The list of CryptoKeyVersions.
    CryptoKeyVersions []*CryptoKeyVersion `json:"cryptoKeyVersions,omitempty"`
    // NextPageToken: A token to retrieve next page of results. Pass this value in
    // ListCryptoKeyVersionsRequest.page_token to retrieve the next page of
    // results.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // TotalSize: The total number of CryptoKeyVersions that matched the query.
    TotalSize int64 `json:"totalSize,omitempty"`

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

func (s *ListCryptoKeyVersionsResponse) MarshalJSON() ([]byte, error)

type ListCryptoKeysResponse ¶

ListCryptoKeysResponse: Response message for KeyManagementService.ListCryptoKeys.

type ListCryptoKeysResponse struct {
    // CryptoKeys: The list of CryptoKeys.
    CryptoKeys []*CryptoKey `json:"cryptoKeys,omitempty"`
    // NextPageToken: A token to retrieve next page of results. Pass this value in
    // ListCryptoKeysRequest.page_token to retrieve the next page of results.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // TotalSize: The total number of CryptoKeys that matched the query.
    TotalSize int64 `json:"totalSize,omitempty"`

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

func (s *ListCryptoKeysResponse) MarshalJSON() ([]byte, error)

type ListEkmConnectionsResponse ¶

ListEkmConnectionsResponse: Response message for EkmService.ListEkmConnections.

type ListEkmConnectionsResponse struct {
    // EkmConnections: The list of EkmConnections.
    EkmConnections []*EkmConnection `json:"ekmConnections,omitempty"`
    // NextPageToken: A token to retrieve next page of results. Pass this value in
    // ListEkmConnectionsRequest.page_token to retrieve the next page of results.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // TotalSize: The total number of EkmConnections that matched the query.
    TotalSize int64 `json:"totalSize,omitempty"`

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

func (s *ListEkmConnectionsResponse) MarshalJSON() ([]byte, error)

type ListImportJobsResponse ¶

ListImportJobsResponse: Response message for KeyManagementService.ListImportJobs.

type ListImportJobsResponse struct {
    // ImportJobs: The list of ImportJobs.
    ImportJobs []*ImportJob `json:"importJobs,omitempty"`
    // NextPageToken: A token to retrieve next page of results. Pass this value in
    // ListImportJobsRequest.page_token to retrieve the next page of results.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // TotalSize: The total number of ImportJobs that matched the query.
    TotalSize int64 `json:"totalSize,omitempty"`

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

func (s *ListImportJobsResponse) MarshalJSON() ([]byte, error)

type ListKeyHandlesResponse ¶

ListKeyHandlesResponse: Response message for Autokey.ListKeyHandles.

type ListKeyHandlesResponse struct {
    // KeyHandles: Resulting KeyHandles.
    KeyHandles []*KeyHandle `json:"keyHandles,omitempty"`

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

func (s *ListKeyHandlesResponse) MarshalJSON() ([]byte, error)

type ListKeyRingsResponse ¶

ListKeyRingsResponse: Response message for KeyManagementService.ListKeyRings.

type ListKeyRingsResponse struct {
    // KeyRings: The list of KeyRings.
    KeyRings []*KeyRing `json:"keyRings,omitempty"`
    // NextPageToken: A token to retrieve next page of results. Pass this value in
    // ListKeyRingsRequest.page_token to retrieve the next page of results.
    NextPageToken string `json:"nextPageToken,omitempty"`
    // TotalSize: The total number of KeyRings that matched the query.
    TotalSize int64 `json:"totalSize,omitempty"`

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

func (s *ListKeyRingsResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse ¶

ListLocationsResponse: The response message for Locations.ListLocations.

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:"-"`
}

func (*ListLocationsResponse) MarshalJSON ¶

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

type Location ¶

Location: A resource that represents a Google Cloud 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:"-"`
}

func (*Location) MarshalJSON ¶

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

type LocationMetadata ¶

LocationMetadata: Cloud KMS metadata for the given google.cloud.location.Location.

type LocationMetadata struct {
    // EkmAvailable: Indicates whether CryptoKeys with protection_level EXTERNAL
    // can be created in this location.
    EkmAvailable bool `json:"ekmAvailable,omitempty"`
    // HsmAvailable: Indicates whether CryptoKeys with protection_level HSM can be
    // created in this location.
    HsmAvailable bool `json:"hsmAvailable,omitempty"`
    // ForceSendFields is a list of field names (e.g. "EkmAvailable") 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. "EkmAvailable") 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 (*LocationMetadata) MarshalJSON ¶

func (s *LocationMetadata) MarshalJSON() ([]byte, error)

type MacSignRequest ¶

MacSignRequest: Request message for KeyManagementService.MacSign.

type MacSignRequest struct {
    // Data: Required. The data to sign. The MAC tag is computed over this data
    // field based on the specific algorithm.
    Data string `json:"data,omitempty"`
    // DataCrc32c: Optional. An optional CRC32C checksum of the
    // MacSignRequest.data. If specified, KeyManagementService will verify the
    // integrity of the received MacSignRequest.data using this checksum.
    // KeyManagementService will report an error if the checksum verification
    // fails. If you receive a checksum error, your client should verify that
    // CRC32C(MacSignRequest.data) is equal to MacSignRequest.data_crc32c, and if
    // so, perform a limited number of retries. A persistent mismatch may indicate
    // an issue in your computation of the CRC32C checksum. Note: This field is
    // defined as int64 for reasons of compatibility across different languages.
    // However, it is a non-negative integer, which will never exceed 2^32-1, and
    // can be safely downconverted to uint32 in languages that support this type.
    DataCrc32c int64 `json:"dataCrc32c,omitempty,string"`
    // ForceSendFields is a list of field names (e.g. "Data") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Data") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MacSignRequest) MarshalJSON ¶

func (s *MacSignRequest) MarshalJSON() ([]byte, error)

type MacSignResponse ¶

MacSignResponse: Response message for KeyManagementService.MacSign.

type MacSignResponse struct {
    // Mac: The created signature.
    Mac string `json:"mac,omitempty"`
    // MacCrc32c: Integrity verification field. A CRC32C checksum of the returned
    // MacSignResponse.mac. An integrity check of MacSignResponse.mac can be
    // performed by computing the CRC32C checksum of MacSignResponse.mac and
    // comparing your results to this field. Discard the response in case of
    // non-matching checksum values, and perform a limited number of retries. A
    // persistent mismatch may indicate an issue in your computation of the CRC32C
    // checksum. Note: This field is defined as int64 for reasons of compatibility
    // across different languages. However, it is a non-negative integer, which
    // will never exceed 2^32-1, and can be safely downconverted to uint32 in
    // languages that support this type.
    MacCrc32c int64 `json:"macCrc32c,omitempty,string"`
    // Name: The resource name of the CryptoKeyVersion used for signing. Check this
    // field to verify that the intended resource was used for signing.
    Name string `json:"name,omitempty"`
    // ProtectionLevel: The ProtectionLevel of the CryptoKeyVersion used for
    // signing.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // VerifiedDataCrc32c: Integrity verification field. A flag indicating whether
    // MacSignRequest.data_crc32c was received by KeyManagementService and used for
    // the integrity verification of the data. A false value of this field
    // indicates either that MacSignRequest.data_crc32c was left unset or that it
    // was not delivered to KeyManagementService. If you've set
    // MacSignRequest.data_crc32c but this field is still false, discard the
    // response and perform a limited number of retries.
    VerifiedDataCrc32c bool `json:"verifiedDataCrc32c,omitempty"`

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

func (s *MacSignResponse) MarshalJSON() ([]byte, error)

type MacVerifyRequest ¶

MacVerifyRequest: Request message for KeyManagementService.MacVerify.

type MacVerifyRequest struct {
    // Data: Required. The data used previously as a MacSignRequest.data to
    // generate the MAC tag.
    Data string `json:"data,omitempty"`
    // DataCrc32c: Optional. An optional CRC32C checksum of the
    // MacVerifyRequest.data. If specified, KeyManagementService will verify the
    // integrity of the received MacVerifyRequest.data using this checksum.
    // KeyManagementService will report an error if the checksum verification
    // fails. If you receive a checksum error, your client should verify that
    // CRC32C(MacVerifyRequest.data) is equal to MacVerifyRequest.data_crc32c, and
    // if so, perform a limited number of retries. A persistent mismatch may
    // indicate an issue in your computation of the CRC32C checksum. Note: This
    // field is defined as int64 for reasons of compatibility across different
    // languages. However, it is a non-negative integer, which will never exceed
    // 2^32-1, and can be safely downconverted to uint32 in languages that support
    // this type.
    DataCrc32c int64 `json:"dataCrc32c,omitempty,string"`
    // Mac: Required. The signature to verify.
    Mac string `json:"mac,omitempty"`
    // MacCrc32c: Optional. An optional CRC32C checksum of the
    // MacVerifyRequest.mac. If specified, KeyManagementService will verify the
    // integrity of the received MacVerifyRequest.mac using this checksum.
    // KeyManagementService will report an error if the checksum verification
    // fails. If you receive a checksum error, your client should verify that
    // CRC32C(MacVerifyRequest.tag) is equal to MacVerifyRequest.mac_crc32c, and if
    // so, perform a limited number of retries. A persistent mismatch may indicate
    // an issue in your computation of the CRC32C checksum. Note: This field is
    // defined as int64 for reasons of compatibility across different languages.
    // However, it is a non-negative integer, which will never exceed 2^32-1, and
    // can be safely downconverted to uint32 in languages that support this type.
    MacCrc32c int64 `json:"macCrc32c,omitempty,string"`
    // ForceSendFields is a list of field names (e.g. "Data") to unconditionally
    // include in API requests. By default, fields with empty or default values are
    // omitted from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
    // details.
    ForceSendFields []string `json:"-"`
    // NullFields is a list of field names (e.g. "Data") to include in API requests
    // with the JSON null value. By default, fields with empty values are omitted
    // from API requests. See
    // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
    NullFields []string `json:"-"`
}

func (*MacVerifyRequest) MarshalJSON ¶

func (s *MacVerifyRequest) MarshalJSON() ([]byte, error)

type MacVerifyResponse ¶

MacVerifyResponse: Response message for KeyManagementService.MacVerify.

type MacVerifyResponse struct {
    // Name: The resource name of the CryptoKeyVersion used for verification. Check
    // this field to verify that the intended resource was used for verification.
    Name string `json:"name,omitempty"`
    // ProtectionLevel: The ProtectionLevel of the CryptoKeyVersion used for
    // verification.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // Success: This field indicates whether or not the verification operation for
    // MacVerifyRequest.mac over MacVerifyRequest.data was successful.
    Success bool `json:"success,omitempty"`
    // VerifiedDataCrc32c: Integrity verification field. A flag indicating whether
    // MacVerifyRequest.data_crc32c was received by KeyManagementService and used
    // for the integrity verification of the data. A false value of this field
    // indicates either that MacVerifyRequest.data_crc32c was left unset or that it
    // was not delivered to KeyManagementService. If you've set
    // MacVerifyRequest.data_crc32c but this field is still false, discard the
    // response and perform a limited number of retries.
    VerifiedDataCrc32c bool `json:"verifiedDataCrc32c,omitempty"`
    // VerifiedMacCrc32c: Integrity verification field. A flag indicating whether
    // MacVerifyRequest.mac_crc32c was received by KeyManagementService and used
    // for the integrity verification of the data. A false value of this field
    // indicates either that MacVerifyRequest.mac_crc32c was left unset or that it
    // was not delivered to KeyManagementService. If you've set
    // MacVerifyRequest.mac_crc32c but this field is still false, discard the
    // response and perform a limited number of retries.
    VerifiedMacCrc32c bool `json:"verifiedMacCrc32c,omitempty"`
    // VerifiedSuccessIntegrity: Integrity verification field. This value is used
    // for the integrity verification of [MacVerifyResponse.success]. If the value
    // of this field contradicts the value of [MacVerifyResponse.success], discard
    // the response and perform a limited number of retries.
    VerifiedSuccessIntegrity bool `json:"verifiedSuccessIntegrity,omitempty"`

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

func (*MacVerifyResponse) MarshalJSON ¶

func (s *MacVerifyResponse) MarshalJSON() ([]byte, error)

type Operation ¶

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

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:"-"`
}

func (*Operation) MarshalJSON ¶

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

type Policy ¶

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/).

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:"-"`
}

func (*Policy) MarshalJSON ¶

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

type ProjectsLocationsEkmConfigGetIamPolicyCall ¶

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

func (*ProjectsLocationsEkmConfigGetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsEkmConfigGetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.ekmConfig.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 (*ProjectsLocationsEkmConfigGetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConfigGetIamPolicyCall) Header ¶

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

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

func (*ProjectsLocationsEkmConfigGetIamPolicyCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsEkmConfigGetIamPolicyCall) OptionsRequestedPolicyVersion ¶

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

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 ProjectsLocationsEkmConfigService ¶

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

func NewProjectsLocationsEkmConfigService ¶

func NewProjectsLocationsEkmConfigService(s *Service) *ProjectsLocationsEkmConfigService

func (*ProjectsLocationsEkmConfigService) GetIamPolicy ¶

func (r *ProjectsLocationsEkmConfigService) GetIamPolicy(resource string) *ProjectsLocationsEkmConfigGetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsEkmConfigService) SetIamPolicy ¶

func (r *ProjectsLocationsEkmConfigService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsEkmConfigSetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsEkmConfigService) TestIamPermissions ¶

func (r *ProjectsLocationsEkmConfigService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsEkmConfigTestIamPermissionsCall

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.

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

type ProjectsLocationsEkmConfigSetIamPolicyCall ¶

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

func (*ProjectsLocationsEkmConfigSetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsEkmConfigSetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.ekmConfig.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 (*ProjectsLocationsEkmConfigSetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConfigSetIamPolicyCall) Header ¶

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

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

type ProjectsLocationsEkmConfigTestIamPermissionsCall ¶

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

func (*ProjectsLocationsEkmConfigTestIamPermissionsCall) Context ¶

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

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

func (*ProjectsLocationsEkmConfigTestIamPermissionsCall) Do ¶

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

Do executes the "cloudkms.projects.locations.ekmConfig.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 (*ProjectsLocationsEkmConfigTestIamPermissionsCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConfigTestIamPermissionsCall) Header ¶

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

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

type ProjectsLocationsEkmConnectionsCreateCall ¶

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

func (*ProjectsLocationsEkmConnectionsCreateCall) Context ¶

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

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

func (*ProjectsLocationsEkmConnectionsCreateCall) Do ¶

func (c *ProjectsLocationsEkmConnectionsCreateCall) Do(opts ...googleapi.CallOption) (*EkmConnection, error)

Do executes the "cloudkms.projects.locations.ekmConnections.create" call. Any non-2xx status code is an error. Response headers are in either *EkmConnection.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 (*ProjectsLocationsEkmConnectionsCreateCall) EkmConnectionId ¶

func (c *ProjectsLocationsEkmConnectionsCreateCall) EkmConnectionId(ekmConnectionId string) *ProjectsLocationsEkmConnectionsCreateCall

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

func (*ProjectsLocationsEkmConnectionsCreateCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConnectionsCreateCall) Header ¶

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

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

type ProjectsLocationsEkmConnectionsGetCall ¶

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

func (*ProjectsLocationsEkmConnectionsGetCall) Context ¶

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

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

func (*ProjectsLocationsEkmConnectionsGetCall) Do ¶

func (c *ProjectsLocationsEkmConnectionsGetCall) Do(opts ...googleapi.CallOption) (*EkmConnection, error)

Do executes the "cloudkms.projects.locations.ekmConnections.get" call. Any non-2xx status code is an error. Response headers are in either *EkmConnection.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 (*ProjectsLocationsEkmConnectionsGetCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConnectionsGetCall) Header ¶

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

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

func (*ProjectsLocationsEkmConnectionsGetCall) IfNoneMatch ¶

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

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 ProjectsLocationsEkmConnectionsGetIamPolicyCall ¶

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

func (*ProjectsLocationsEkmConnectionsGetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsEkmConnectionsGetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.ekmConnections.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 (*ProjectsLocationsEkmConnectionsGetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConnectionsGetIamPolicyCall) Header ¶

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

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

func (*ProjectsLocationsEkmConnectionsGetIamPolicyCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsEkmConnectionsGetIamPolicyCall) OptionsRequestedPolicyVersion ¶

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

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 ProjectsLocationsEkmConnectionsListCall ¶

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

func (*ProjectsLocationsEkmConnectionsListCall) Context ¶

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

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

func (*ProjectsLocationsEkmConnectionsListCall) Do ¶

func (c *ProjectsLocationsEkmConnectionsListCall) Do(opts ...googleapi.CallOption) (*ListEkmConnectionsResponse, error)

Do executes the "cloudkms.projects.locations.ekmConnections.list" call. Any non-2xx status code is an error. Response headers are in either *ListEkmConnectionsResponse.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 (*ProjectsLocationsEkmConnectionsListCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConnectionsListCall) Filter ¶

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

Filter sets the optional parameter "filter": Only include resources that match the filter in the response. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsEkmConnectionsListCall) Header ¶

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

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

func (*ProjectsLocationsEkmConnectionsListCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsEkmConnectionsListCall) OrderBy ¶

func (c *ProjectsLocationsEkmConnectionsListCall) OrderBy(orderBy string) *ProjectsLocationsEkmConnectionsListCall

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsEkmConnectionsListCall) PageSize ¶

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

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

func (*ProjectsLocationsEkmConnectionsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": Optional pagination token, returned earlier via ListEkmConnectionsResponse.next_page_token.

func (*ProjectsLocationsEkmConnectionsListCall) Pages ¶

func (c *ProjectsLocationsEkmConnectionsListCall) Pages(ctx context.Context, f func(*ListEkmConnectionsResponse) error) error

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

type ProjectsLocationsEkmConnectionsPatchCall ¶

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

func (*ProjectsLocationsEkmConnectionsPatchCall) Context ¶

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

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

func (*ProjectsLocationsEkmConnectionsPatchCall) Do ¶

func (c *ProjectsLocationsEkmConnectionsPatchCall) Do(opts ...googleapi.CallOption) (*EkmConnection, error)

Do executes the "cloudkms.projects.locations.ekmConnections.patch" call. Any non-2xx status code is an error. Response headers are in either *EkmConnection.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 (*ProjectsLocationsEkmConnectionsPatchCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConnectionsPatchCall) Header ¶

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

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

func (*ProjectsLocationsEkmConnectionsPatchCall) UpdateMask ¶

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

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

type ProjectsLocationsEkmConnectionsService ¶

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

func NewProjectsLocationsEkmConnectionsService ¶

func NewProjectsLocationsEkmConnectionsService(s *Service) *ProjectsLocationsEkmConnectionsService

func (*ProjectsLocationsEkmConnectionsService) Create ¶

func (r *ProjectsLocationsEkmConnectionsService) Create(parent string, ekmconnection *EkmConnection) *ProjectsLocationsEkmConnectionsCreateCall

Create: Creates a new EkmConnection in a given Project and Location.

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

func (*ProjectsLocationsEkmConnectionsService) Get ¶

func (r *ProjectsLocationsEkmConnectionsService) Get(name string) *ProjectsLocationsEkmConnectionsGetCall

Get: Returns metadata for a given EkmConnection.

- name: The name of the EkmConnection to get.

func (*ProjectsLocationsEkmConnectionsService) GetIamPolicy ¶

func (r *ProjectsLocationsEkmConnectionsService) GetIamPolicy(resource string) *ProjectsLocationsEkmConnectionsGetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsEkmConnectionsService) List ¶

func (r *ProjectsLocationsEkmConnectionsService) List(parent string) *ProjectsLocationsEkmConnectionsListCall

List: Lists EkmConnections.

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

func (*ProjectsLocationsEkmConnectionsService) Patch ¶

func (r *ProjectsLocationsEkmConnectionsService) Patch(name string, ekmconnection *EkmConnection) *ProjectsLocationsEkmConnectionsPatchCall

Patch: Updates an EkmConnection's metadata.

• name: Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`.

func (*ProjectsLocationsEkmConnectionsService) SetIamPolicy ¶

func (r *ProjectsLocationsEkmConnectionsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsEkmConnectionsSetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsEkmConnectionsService) TestIamPermissions ¶

func (r *ProjectsLocationsEkmConnectionsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsEkmConnectionsTestIamPermissionsCall

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.

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsEkmConnectionsService) VerifyConnectivity ¶

func (r *ProjectsLocationsEkmConnectionsService) VerifyConnectivity(name string) *ProjectsLocationsEkmConnectionsVerifyConnectivityCall

VerifyConnectivity: Verifies that Cloud KMS can successfully connect to the external key manager specified by an EkmConnection. If there is an error connecting to the EKM, this method returns a FAILED_PRECONDITION status containing structured information as described at https://cloud.google.com/kms/docs/reference/ekm_errors.

- name: The name of the EkmConnection to verify.

type ProjectsLocationsEkmConnectionsSetIamPolicyCall ¶

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

func (*ProjectsLocationsEkmConnectionsSetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsEkmConnectionsSetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.ekmConnections.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 (*ProjectsLocationsEkmConnectionsSetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConnectionsSetIamPolicyCall) Header ¶

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

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

type ProjectsLocationsEkmConnectionsTestIamPermissionsCall ¶

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

func (*ProjectsLocationsEkmConnectionsTestIamPermissionsCall) Context ¶

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

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

func (*ProjectsLocationsEkmConnectionsTestIamPermissionsCall) Do ¶

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

Do executes the "cloudkms.projects.locations.ekmConnections.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 (*ProjectsLocationsEkmConnectionsTestIamPermissionsCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConnectionsTestIamPermissionsCall) Header ¶

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

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

type ProjectsLocationsEkmConnectionsVerifyConnectivityCall ¶

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

func (*ProjectsLocationsEkmConnectionsVerifyConnectivityCall) Context ¶

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

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

func (*ProjectsLocationsEkmConnectionsVerifyConnectivityCall) Do ¶

func (c *ProjectsLocationsEkmConnectionsVerifyConnectivityCall) Do(opts ...googleapi.CallOption) (*VerifyConnectivityResponse, error)

Do executes the "cloudkms.projects.locations.ekmConnections.verifyConnectivity" call. Any non-2xx status code is an error. Response headers are in either *VerifyConnectivityResponse.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 (*ProjectsLocationsEkmConnectionsVerifyConnectivityCall) Fields ¶

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

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

func (*ProjectsLocationsEkmConnectionsVerifyConnectivityCall) Header ¶

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

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

func (*ProjectsLocationsEkmConnectionsVerifyConnectivityCall) IfNoneMatch ¶

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

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 ProjectsLocationsGenerateRandomBytesCall ¶

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

func (*ProjectsLocationsGenerateRandomBytesCall) Context ¶

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

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

func (*ProjectsLocationsGenerateRandomBytesCall) Do ¶

func (c *ProjectsLocationsGenerateRandomBytesCall) Do(opts ...googleapi.CallOption) (*GenerateRandomBytesResponse, error)

Do executes the "cloudkms.projects.locations.generateRandomBytes" call. Any non-2xx status code is an error. Response headers are in either *GenerateRandomBytesResponse.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 (*ProjectsLocationsGenerateRandomBytesCall) Fields ¶

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

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

func (*ProjectsLocationsGenerateRandomBytesCall) Header ¶

func (c *ProjectsLocationsGenerateRandomBytesCall) Header() http.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 ¶

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

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

func (*ProjectsLocationsGetCall) Do ¶

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

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

func (*ProjectsLocationsGetCall) Fields ¶

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

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

func (*ProjectsLocationsGetCall) Header ¶

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

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

func (*ProjectsLocationsGetCall) IfNoneMatch ¶

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

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

type ProjectsLocationsGetEkmConfigCall ¶

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

func (*ProjectsLocationsGetEkmConfigCall) Context ¶

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

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

func (*ProjectsLocationsGetEkmConfigCall) Do ¶

func (c *ProjectsLocationsGetEkmConfigCall) Do(opts ...googleapi.CallOption) (*EkmConfig, error)

Do executes the "cloudkms.projects.locations.getEkmConfig" call. Any non-2xx status code is an error. Response headers are in either *EkmConfig.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 (*ProjectsLocationsGetEkmConfigCall) Fields ¶

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

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

func (*ProjectsLocationsGetEkmConfigCall) Header ¶

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

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

func (*ProjectsLocationsGetEkmConfigCall) IfNoneMatch ¶

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

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 ProjectsLocationsKeyHandlesCreateCall ¶

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

func (*ProjectsLocationsKeyHandlesCreateCall) Context ¶

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

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

func (*ProjectsLocationsKeyHandlesCreateCall) Do ¶

func (c *ProjectsLocationsKeyHandlesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "cloudkms.projects.locations.keyHandles.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 (*ProjectsLocationsKeyHandlesCreateCall) Fields ¶

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

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

func (*ProjectsLocationsKeyHandlesCreateCall) Header ¶

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

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

func (*ProjectsLocationsKeyHandlesCreateCall) KeyHandleId ¶

func (c *ProjectsLocationsKeyHandlesCreateCall) KeyHandleId(keyHandleId string) *ProjectsLocationsKeyHandlesCreateCall

KeyHandleId sets the optional parameter "keyHandleId": Id of the KeyHandle. Must be unique to the resource project and location. If not provided by the caller, a new UUID is used.

type ProjectsLocationsKeyHandlesGetCall ¶

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

func (*ProjectsLocationsKeyHandlesGetCall) Context ¶

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

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

func (*ProjectsLocationsKeyHandlesGetCall) Do ¶

func (c *ProjectsLocationsKeyHandlesGetCall) Do(opts ...googleapi.CallOption) (*KeyHandle, error)

Do executes the "cloudkms.projects.locations.keyHandles.get" call. Any non-2xx status code is an error. Response headers are in either *KeyHandle.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 (*ProjectsLocationsKeyHandlesGetCall) Fields ¶

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

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

func (*ProjectsLocationsKeyHandlesGetCall) Header ¶

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

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

func (*ProjectsLocationsKeyHandlesGetCall) IfNoneMatch ¶

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

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 ProjectsLocationsKeyHandlesListCall ¶

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

func (*ProjectsLocationsKeyHandlesListCall) Context ¶

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

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

func (*ProjectsLocationsKeyHandlesListCall) Do ¶

func (c *ProjectsLocationsKeyHandlesListCall) Do(opts ...googleapi.CallOption) (*ListKeyHandlesResponse, error)

Do executes the "cloudkms.projects.locations.keyHandles.list" call. Any non-2xx status code is an error. Response headers are in either *ListKeyHandlesResponse.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 (*ProjectsLocationsKeyHandlesListCall) Fields ¶

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

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

func (*ProjectsLocationsKeyHandlesListCall) Filter ¶

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

Filter sets the optional parameter "filter": Filter to apply when listing KeyHandles, e.g. `resource_type_selector="{SERVICE}.googleapis.com/{TYPE}".

func (*ProjectsLocationsKeyHandlesListCall) Header ¶

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

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

func (*ProjectsLocationsKeyHandlesListCall) IfNoneMatch ¶

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

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 ProjectsLocationsKeyHandlesService ¶

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

func NewProjectsLocationsKeyHandlesService ¶

func NewProjectsLocationsKeyHandlesService(s *Service) *ProjectsLocationsKeyHandlesService

func (*ProjectsLocationsKeyHandlesService) Create ¶

func (r *ProjectsLocationsKeyHandlesService) Create(parent string, keyhandle *KeyHandle) *ProjectsLocationsKeyHandlesCreateCall

Create: Creates a new KeyHandle, triggering the provisioning of a new CryptoKey for CMEK use with the given resource type in the configured key project and the same location. GetOperation should be used to resolve the resulting long-running operation and get the resulting KeyHandle and CryptoKey.

• parent: Name of the resource project and location to create the KeyHandle in, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}`.

func (*ProjectsLocationsKeyHandlesService) Get ¶

func (r *ProjectsLocationsKeyHandlesService) Get(name string) *ProjectsLocationsKeyHandlesGetCall

Get: Returns the KeyHandle.

• name: Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.

func (*ProjectsLocationsKeyHandlesService) List ¶

func (r *ProjectsLocationsKeyHandlesService) List(parent string) *ProjectsLocationsKeyHandlesListCall

List: Lists KeyHandles.

• parent: Name of the resource project and location from which to list KeyHandles, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}`.

type ProjectsLocationsKeyRingsCreateCall ¶

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

func (*ProjectsLocationsKeyRingsCreateCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCreateCall) Do ¶

func (c *ProjectsLocationsKeyRingsCreateCall) Do(opts ...googleapi.CallOption) (*KeyRing, error)

Do executes the "cloudkms.projects.locations.keyRings.create" call. Any non-2xx status code is an error. Response headers are in either *KeyRing.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 (*ProjectsLocationsKeyRingsCreateCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCreateCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCreateCall) KeyRingId ¶

func (c *ProjectsLocationsKeyRingsCreateCall) KeyRingId(keyRingId string) *ProjectsLocationsKeyRingsCreateCall

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

type ProjectsLocationsKeyRingsCryptoKeysCreateCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCreateCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCreateCall) CryptoKeyId ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCreateCall) CryptoKeyId(cryptoKeyId string) *ProjectsLocationsKeyRingsCryptoKeysCreateCall

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

func (*ProjectsLocationsKeyRingsCryptoKeysCreateCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCreateCall) Do(opts ...googleapi.CallOption) (*CryptoKey, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.create" call. Any non-2xx status code is an error. Response headers are in either *CryptoKey.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 (*ProjectsLocationsKeyRingsCryptoKeysCreateCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCreateCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCreateCall) SkipInitialVersionCreation ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCreateCall) SkipInitialVersionCreation(skipInitialVersionCreation bool) *ProjectsLocationsKeyRingsCryptoKeysCreateCall

SkipInitialVersionCreation sets the optional parameter "skipInitialVersionCreation": If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey.

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricDecryptCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricDecryptCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricDecryptCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricDecryptCall) Do(opts ...googleapi.CallOption) (*AsymmetricDecryptResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.asymmetricDecrypt" call. Any non-2xx status code is an error. Response headers are in either *AsymmetricDecryptResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricDecryptCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricDecryptCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricSignCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricSignCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricSignCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricSignCall) Do(opts ...googleapi.CallOption) (*AsymmetricSignResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.asymmetricSign" call. Any non-2xx status code is an error. Response headers are in either *AsymmetricSignResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricSignCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricSignCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create" call. Any non-2xx status code is an error. Response headers are in either *CryptoKeyVersion.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy" call. Any non-2xx status code is an error. Response headers are in either *CryptoKeyVersion.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get" call. Any non-2xx status code is an error. Response headers are in either *CryptoKeyVersion.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) IfNoneMatch ¶

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

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 ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetPublicKeyCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetPublicKeyCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetPublicKeyCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetPublicKeyCall) Do(opts ...googleapi.CallOption) (*PublicKey, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.getPublicKey" call. Any non-2xx status code is an error. Response headers are in either *PublicKey.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetPublicKeyCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetPublicKeyCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetPublicKeyCall) IfNoneMatch ¶

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

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 ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsImportCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsImportCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsImportCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsImportCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.import" call. Any non-2xx status code is an error. Response headers are in either *CryptoKeyVersion.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsImportCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsImportCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Do(opts ...googleapi.CallOption) (*ListCryptoKeyVersionsResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list" call. Any non-2xx status code is an error. Response headers are in either *ListCryptoKeyVersionsResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Filter ¶

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

Filter sets the optional parameter "filter": Only include resources that match the filter in the response. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) OrderBy ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) OrderBy(orderBy string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) PageSize ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": Optional pagination token, returned earlier via ListCryptoKeyVersionsResponse.next_page_token.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Pages ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Pages(ctx context.Context, f func(*ListCryptoKeyVersionsResponse) error) error

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) View ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) View(view string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall

View sets the optional parameter "view": The fields to include in the response.

Possible values:

"CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED" - Default view for each

CryptoKeyVersion. Does not include the attestation field.

"FULL" - Provides all fields in each CryptoKeyVersion, including the

attestation.

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacSignCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacSignCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacSignCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacSignCall) Do(opts ...googleapi.CallOption) (*MacSignResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.macSign" call. Any non-2xx status code is an error. Response headers are in either *MacSignResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacSignCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacSignCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacVerifyCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacVerifyCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacVerifyCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacVerifyCall) Do(opts ...googleapi.CallOption) (*MacVerifyResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.macVerify" call. Any non-2xx status code is an error. Response headers are in either *MacVerifyResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacVerifyCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacVerifyCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch" call. Any non-2xx status code is an error. Response headers are in either *CryptoKeyVersion.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) UpdateMask ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawDecryptCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawDecryptCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawDecryptCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawDecryptCall) Do(opts ...googleapi.CallOption) (*RawDecryptResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.rawDecrypt" call. Any non-2xx status code is an error. Response headers are in either *RawDecryptResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawDecryptCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawDecryptCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawEncryptCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawEncryptCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawEncryptCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawEncryptCall) Do(opts ...googleapi.CallOption) (*RawEncryptResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.rawEncrypt" call. Any non-2xx status code is an error. Response headers are in either *RawEncryptResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawEncryptCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawEncryptCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore" call. Any non-2xx status code is an error. Response headers are in either *CryptoKeyVersion.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 (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService ¶

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

func NewProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService ¶

func NewProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService(s *Service) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) AsymmetricDecrypt ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) AsymmetricDecrypt(name string, asymmetricdecryptrequest *AsymmetricDecryptRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricDecryptCall

AsymmetricDecrypt: Decrypts data that was encrypted with a public key retrieved from GetPublicKey corresponding to a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_DECRYPT.

- name: The resource name of the CryptoKeyVersion to use for decryption.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) AsymmetricSign ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) AsymmetricSign(name string, asymmetricsignrequest *AsymmetricSignRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsAsymmetricSignCall

AsymmetricSign: Signs data using a CryptoKeyVersion with CryptoKey.purpose ASYMMETRIC_SIGN, producing a signature that can be verified with the public key retrieved from GetPublicKey.

- name: The resource name of the CryptoKeyVersion to use for signing.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Create ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Create(parent string, cryptokeyversion *CryptoKeyVersion) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall

Create: Create a new CryptoKeyVersion in a CryptoKey. The server will assign the next sequential id. If unset, state will be set to ENABLED.

- parent: The name of the CryptoKey associated with the CryptoKeyVersions.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Destroy ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Destroy(name string, destroycryptokeyversionrequest *DestroyCryptoKeyVersionRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall

Destroy: Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.

- name: The resource name of the CryptoKeyVersion to destroy.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Get ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Get(name string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall

Get: Returns metadata for a given CryptoKeyVersion.

- name: The name of the CryptoKeyVersion to get.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) GetPublicKey ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) GetPublicKey(name string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetPublicKeyCall

GetPublicKey: Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.

- name: The name of the CryptoKeyVersion public key to get.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Import ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Import(parent string, importcryptokeyversionrequest *ImportCryptoKeyVersionRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsImportCall

Import: Import wrapped key material into a CryptoKeyVersion. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey.

• parent: The name of the CryptoKey to be imported into. The create permission is only required on this key when creating a new CryptoKeyVersion.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) List ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) List(parent string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall

List: Lists CryptoKeyVersions.

• parent: The resource name of the CryptoKey to list, in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) MacSign ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) MacSign(name string, macsignrequest *MacSignRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacSignCall

MacSign: Signs data using a CryptoKeyVersion with CryptoKey.purpose MAC, producing a tag that can be verified by another source with the same key.

- name: The resource name of the CryptoKeyVersion to use for signing.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) MacVerify ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) MacVerify(name string, macverifyrequest *MacVerifyRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsMacVerifyCall

MacVerify: Verifies MAC tag using a CryptoKeyVersion with CryptoKey.purpose MAC, and returns a response that indicates whether or not the verification was successful.

- name: The resource name of the CryptoKeyVersion to use for verification.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Patch ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Patch(name string, cryptokeyversion *CryptoKeyVersion) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall

Patch: Update a CryptoKeyVersion's metadata. state may be changed between ENABLED and DISABLED using this method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to move between other states.

• name: Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) RawDecrypt ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) RawDecrypt(name string, rawdecryptrequest *RawDecryptRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawDecryptCall

RawDecrypt: Decrypts data that was originally encrypted using a raw cryptographic mechanism. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT.

- name: The resource name of the CryptoKeyVersion to use for decryption.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) RawEncrypt ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) RawEncrypt(name string, rawencryptrequest *RawEncryptRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRawEncryptCall

RawEncrypt: Encrypts data using portable cryptographic primitives. Most users should choose Encrypt and Decrypt rather than their raw counterparts. The CryptoKey.purpose must be RAW_ENCRYPT_DECRYPT.

- name: The resource name of the CryptoKeyVersion to use for encryption.

func (*ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Restore ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Restore(name string, restorecryptokeyversionrequest *RestoreCryptoKeyVersionRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall

Restore: Restore a CryptoKeyVersion in the DESTROY_SCHEDULED state. Upon restoration of the CryptoKeyVersion, state will be set to DISABLED, and destroy_time will be cleared.

- name: The resource name of the CryptoKeyVersion to restore.

type ProjectsLocationsKeyRingsCryptoKeysDecryptCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysDecryptCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysDecryptCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysDecryptCall) Do(opts ...googleapi.CallOption) (*DecryptResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt" call. Any non-2xx status code is an error. Response headers are in either *DecryptResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysDecryptCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysDecryptCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysEncryptCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysEncryptCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysEncryptCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysEncryptCall) Do(opts ...googleapi.CallOption) (*EncryptResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt" call. Any non-2xx status code is an error. Response headers are in either *EncryptResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysEncryptCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysEncryptCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysGetCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysGetCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysGetCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysGetCall) Do(opts ...googleapi.CallOption) (*CryptoKey, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.get" call. Any non-2xx status code is an error. Response headers are in either *CryptoKey.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 (*ProjectsLocationsKeyRingsCryptoKeysGetCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysGetCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysGetCall) IfNoneMatch ¶

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

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 ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.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 (*ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) OptionsRequestedPolicyVersion ¶

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

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 ProjectsLocationsKeyRingsCryptoKeysListCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysListCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysListCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysListCall) Do(opts ...googleapi.CallOption) (*ListCryptoKeysResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.list" call. Any non-2xx status code is an error. Response headers are in either *ListCryptoKeysResponse.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 (*ProjectsLocationsKeyRingsCryptoKeysListCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysListCall) Filter ¶

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

Filter sets the optional parameter "filter": Only include resources that match the filter in the response. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsKeyRingsCryptoKeysListCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysListCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsKeyRingsCryptoKeysListCall) OrderBy ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysListCall) OrderBy(orderBy string) *ProjectsLocationsKeyRingsCryptoKeysListCall

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsKeyRingsCryptoKeysListCall) PageSize ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": Optional pagination token, returned earlier via ListCryptoKeysResponse.next_page_token.

func (*ProjectsLocationsKeyRingsCryptoKeysListCall) Pages ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysListCall) Pages(ctx context.Context, f func(*ListCryptoKeysResponse) error) error

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

func (*ProjectsLocationsKeyRingsCryptoKeysListCall) VersionView ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysListCall) VersionView(versionView string) *ProjectsLocationsKeyRingsCryptoKeysListCall

VersionView sets the optional parameter "versionView": The fields of the primary version to include in the response.

Possible values:

"CRYPTO_KEY_VERSION_VIEW_UNSPECIFIED" - Default view for each

CryptoKeyVersion. Does not include the attestation field.

"FULL" - Provides all fields in each CryptoKeyVersion, including the

attestation.

type ProjectsLocationsKeyRingsCryptoKeysPatchCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysPatchCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysPatchCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysPatchCall) Do(opts ...googleapi.CallOption) (*CryptoKey, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.patch" call. Any non-2xx status code is an error. Response headers are in either *CryptoKey.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 (*ProjectsLocationsKeyRingsCryptoKeysPatchCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysPatchCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysPatchCall) UpdateMask ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysService ¶

type ProjectsLocationsKeyRingsCryptoKeysService struct {
    CryptoKeyVersions *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService
    // contains filtered or unexported fields
}

func NewProjectsLocationsKeyRingsCryptoKeysService ¶

func NewProjectsLocationsKeyRingsCryptoKeysService(s *Service) *ProjectsLocationsKeyRingsCryptoKeysService

func (*ProjectsLocationsKeyRingsCryptoKeysService) Create ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) Create(parent string, cryptokey *CryptoKey) *ProjectsLocationsKeyRingsCryptoKeysCreateCall

Create: Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.

- parent: The name of the KeyRing associated with the CryptoKeys.

func (*ProjectsLocationsKeyRingsCryptoKeysService) Decrypt ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) Decrypt(name string, decryptrequest *DecryptRequest) *ProjectsLocationsKeyRingsCryptoKeysDecryptCall

Decrypt: Decrypts data that was protected by Encrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

• name: The resource name of the CryptoKey to use for decryption. The server will choose the appropriate version.

func (*ProjectsLocationsKeyRingsCryptoKeysService) Encrypt ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) Encrypt(name string, encryptrequest *EncryptRequest) *ProjectsLocationsKeyRingsCryptoKeysEncryptCall

Encrypt: Encrypts data, so that it can only be recovered by a call to Decrypt. The CryptoKey.purpose must be ENCRYPT_DECRYPT.

• name: The resource name of the CryptoKey or CryptoKeyVersion to use for encryption. If a CryptoKey is specified, the server will use its primary version.

func (*ProjectsLocationsKeyRingsCryptoKeysService) Get ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) Get(name string) *ProjectsLocationsKeyRingsCryptoKeysGetCall

Get: Returns metadata for a given CryptoKey, as well as its primary CryptoKeyVersion.

- name: The name of the CryptoKey to get.

func (*ProjectsLocationsKeyRingsCryptoKeysService) GetIamPolicy ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) GetIamPolicy(resource string) *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsKeyRingsCryptoKeysService) List ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) List(parent string) *ProjectsLocationsKeyRingsCryptoKeysListCall

List: Lists CryptoKeys.

• parent: The resource name of the KeyRing to list, in the format `projects/*/locations/*/keyRings/*`.

func (*ProjectsLocationsKeyRingsCryptoKeysService) Patch ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) Patch(name string, cryptokey *CryptoKey) *ProjectsLocationsKeyRingsCryptoKeysPatchCall

Patch: Update a CryptoKey.

• name: Output only. The resource name for this CryptoKey in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`.

func (*ProjectsLocationsKeyRingsCryptoKeysService) SetIamPolicy ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsKeyRingsCryptoKeysService) TestIamPermissions ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall

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.

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsKeyRingsCryptoKeysService) UpdatePrimaryVersion ¶

func (r *ProjectsLocationsKeyRingsCryptoKeysService) UpdatePrimaryVersion(name string, updatecryptokeyprimaryversionrequest *UpdateCryptoKeyPrimaryVersionRequest) *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall

UpdatePrimaryVersion: Update the version of a CryptoKey that will be used in Encrypt. Returns an error if called on a key whose purpose is not ENCRYPT_DECRYPT.

- name: The resource name of the CryptoKey to update.

type ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.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 (*ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall) Do ¶

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

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.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 (*ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall) Header ¶

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

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

type ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall ¶

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

func (*ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) Do ¶

func (c *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) Do(opts ...googleapi.CallOption) (*CryptoKey, error)

Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion" call. Any non-2xx status code is an error. Response headers are in either *CryptoKey.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 (*ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) Header ¶

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

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

type ProjectsLocationsKeyRingsGetCall ¶

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

func (*ProjectsLocationsKeyRingsGetCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsGetCall) Do ¶

func (c *ProjectsLocationsKeyRingsGetCall) Do(opts ...googleapi.CallOption) (*KeyRing, error)

Do executes the "cloudkms.projects.locations.keyRings.get" call. Any non-2xx status code is an error. Response headers are in either *KeyRing.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 (*ProjectsLocationsKeyRingsGetCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsGetCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsGetCall) IfNoneMatch ¶

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

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 ProjectsLocationsKeyRingsGetIamPolicyCall ¶

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

func (*ProjectsLocationsKeyRingsGetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsGetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.keyRings.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 (*ProjectsLocationsKeyRingsGetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsGetIamPolicyCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsGetIamPolicyCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsKeyRingsGetIamPolicyCall) OptionsRequestedPolicyVersion ¶

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

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 ProjectsLocationsKeyRingsImportJobsCreateCall ¶

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

func (*ProjectsLocationsKeyRingsImportJobsCreateCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsCreateCall) Do ¶

func (c *ProjectsLocationsKeyRingsImportJobsCreateCall) Do(opts ...googleapi.CallOption) (*ImportJob, error)

Do executes the "cloudkms.projects.locations.keyRings.importJobs.create" call. Any non-2xx status code is an error. Response headers are in either *ImportJob.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 (*ProjectsLocationsKeyRingsImportJobsCreateCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsCreateCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsCreateCall) ImportJobId ¶

func (c *ProjectsLocationsKeyRingsImportJobsCreateCall) ImportJobId(importJobId string) *ProjectsLocationsKeyRingsImportJobsCreateCall

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

type ProjectsLocationsKeyRingsImportJobsGetCall ¶

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

func (*ProjectsLocationsKeyRingsImportJobsGetCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsGetCall) Do ¶

func (c *ProjectsLocationsKeyRingsImportJobsGetCall) Do(opts ...googleapi.CallOption) (*ImportJob, error)

Do executes the "cloudkms.projects.locations.keyRings.importJobs.get" call. Any non-2xx status code is an error. Response headers are in either *ImportJob.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 (*ProjectsLocationsKeyRingsImportJobsGetCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsGetCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsGetCall) IfNoneMatch ¶

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

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 ProjectsLocationsKeyRingsImportJobsGetIamPolicyCall ¶

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

func (*ProjectsLocationsKeyRingsImportJobsGetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsGetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.keyRings.importJobs.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 (*ProjectsLocationsKeyRingsImportJobsGetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsGetIamPolicyCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsGetIamPolicyCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsKeyRingsImportJobsGetIamPolicyCall) OptionsRequestedPolicyVersion ¶

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

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 ProjectsLocationsKeyRingsImportJobsListCall ¶

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

func (*ProjectsLocationsKeyRingsImportJobsListCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsListCall) Do ¶

func (c *ProjectsLocationsKeyRingsImportJobsListCall) Do(opts ...googleapi.CallOption) (*ListImportJobsResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.importJobs.list" call. Any non-2xx status code is an error. Response headers are in either *ListImportJobsResponse.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 (*ProjectsLocationsKeyRingsImportJobsListCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsListCall) Filter ¶

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

Filter sets the optional parameter "filter": Only include resources that match the filter in the response. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsKeyRingsImportJobsListCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsListCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsKeyRingsImportJobsListCall) OrderBy ¶

func (c *ProjectsLocationsKeyRingsImportJobsListCall) OrderBy(orderBy string) *ProjectsLocationsKeyRingsImportJobsListCall

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsKeyRingsImportJobsListCall) PageSize ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": Optional pagination token, returned earlier via ListImportJobsResponse.next_page_token.

func (*ProjectsLocationsKeyRingsImportJobsListCall) Pages ¶

func (c *ProjectsLocationsKeyRingsImportJobsListCall) Pages(ctx context.Context, f func(*ListImportJobsResponse) error) error

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

type ProjectsLocationsKeyRingsImportJobsService ¶

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

func NewProjectsLocationsKeyRingsImportJobsService ¶

func NewProjectsLocationsKeyRingsImportJobsService(s *Service) *ProjectsLocationsKeyRingsImportJobsService

func (*ProjectsLocationsKeyRingsImportJobsService) Create ¶

func (r *ProjectsLocationsKeyRingsImportJobsService) Create(parent string, importjob *ImportJob) *ProjectsLocationsKeyRingsImportJobsCreateCall

Create: Create a new ImportJob within a KeyRing. ImportJob.import_method is required.

- parent: The name of the KeyRing associated with the ImportJobs.

func (*ProjectsLocationsKeyRingsImportJobsService) Get ¶

func (r *ProjectsLocationsKeyRingsImportJobsService) Get(name string) *ProjectsLocationsKeyRingsImportJobsGetCall

Get: Returns metadata for a given ImportJob.

- name: The name of the ImportJob to get.

func (*ProjectsLocationsKeyRingsImportJobsService) GetIamPolicy ¶

func (r *ProjectsLocationsKeyRingsImportJobsService) GetIamPolicy(resource string) *ProjectsLocationsKeyRingsImportJobsGetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsKeyRingsImportJobsService) List ¶

func (r *ProjectsLocationsKeyRingsImportJobsService) List(parent string) *ProjectsLocationsKeyRingsImportJobsListCall

List: Lists ImportJobs.

• parent: The resource name of the KeyRing to list, in the format `projects/*/locations/*/keyRings/*`.

func (*ProjectsLocationsKeyRingsImportJobsService) SetIamPolicy ¶

func (r *ProjectsLocationsKeyRingsImportJobsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsKeyRingsImportJobsSetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsKeyRingsImportJobsService) TestIamPermissions ¶

func (r *ProjectsLocationsKeyRingsImportJobsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsKeyRingsImportJobsTestIamPermissionsCall

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.

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

type ProjectsLocationsKeyRingsImportJobsSetIamPolicyCall ¶

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

func (*ProjectsLocationsKeyRingsImportJobsSetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsSetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.keyRings.importJobs.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 (*ProjectsLocationsKeyRingsImportJobsSetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsSetIamPolicyCall) Header ¶

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

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

type ProjectsLocationsKeyRingsImportJobsTestIamPermissionsCall ¶

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

func (*ProjectsLocationsKeyRingsImportJobsTestIamPermissionsCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsTestIamPermissionsCall) Do ¶

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

Do executes the "cloudkms.projects.locations.keyRings.importJobs.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 (*ProjectsLocationsKeyRingsImportJobsTestIamPermissionsCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsImportJobsTestIamPermissionsCall) Header ¶

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

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

type ProjectsLocationsKeyRingsListCall ¶

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

func (*ProjectsLocationsKeyRingsListCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsListCall) Do ¶

func (c *ProjectsLocationsKeyRingsListCall) Do(opts ...googleapi.CallOption) (*ListKeyRingsResponse, error)

Do executes the "cloudkms.projects.locations.keyRings.list" call. Any non-2xx status code is an error. Response headers are in either *ListKeyRingsResponse.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 (*ProjectsLocationsKeyRingsListCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsListCall) Filter ¶

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

Filter sets the optional parameter "filter": Only include resources that match the filter in the response. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsKeyRingsListCall) Header ¶

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

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

func (*ProjectsLocationsKeyRingsListCall) IfNoneMatch ¶

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

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 (*ProjectsLocationsKeyRingsListCall) OrderBy ¶

func (c *ProjectsLocationsKeyRingsListCall) OrderBy(orderBy string) *ProjectsLocationsKeyRingsListCall

OrderBy sets the optional parameter "orderBy": Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results (https://cloud.google.com/kms/docs/sorting-and-filtering).

func (*ProjectsLocationsKeyRingsListCall) PageSize ¶

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

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

func (*ProjectsLocationsKeyRingsListCall) PageToken ¶

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

PageToken sets the optional parameter "pageToken": Optional pagination token, returned earlier via ListKeyRingsResponse.next_page_token.

func (*ProjectsLocationsKeyRingsListCall) Pages ¶

func (c *ProjectsLocationsKeyRingsListCall) Pages(ctx context.Context, f func(*ListKeyRingsResponse) error) error

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

type ProjectsLocationsKeyRingsService ¶

type ProjectsLocationsKeyRingsService struct {
    CryptoKeys *ProjectsLocationsKeyRingsCryptoKeysService

    ImportJobs *ProjectsLocationsKeyRingsImportJobsService
    // contains filtered or unexported fields
}

func NewProjectsLocationsKeyRingsService ¶

func NewProjectsLocationsKeyRingsService(s *Service) *ProjectsLocationsKeyRingsService

func (*ProjectsLocationsKeyRingsService) Create ¶

func (r *ProjectsLocationsKeyRingsService) Create(parent string, keyring *KeyRing) *ProjectsLocationsKeyRingsCreateCall

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

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

func (*ProjectsLocationsKeyRingsService) Get ¶

func (r *ProjectsLocationsKeyRingsService) Get(name string) *ProjectsLocationsKeyRingsGetCall

Get: Returns metadata for a given KeyRing.

- name: The name of the KeyRing to get.

func (*ProjectsLocationsKeyRingsService) GetIamPolicy ¶

func (r *ProjectsLocationsKeyRingsService) GetIamPolicy(resource string) *ProjectsLocationsKeyRingsGetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsKeyRingsService) List ¶

func (r *ProjectsLocationsKeyRingsService) List(parent string) *ProjectsLocationsKeyRingsListCall

List: Lists KeyRings.

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

func (*ProjectsLocationsKeyRingsService) SetIamPolicy ¶

func (r *ProjectsLocationsKeyRingsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsKeyRingsSetIamPolicyCall

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

• resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

func (*ProjectsLocationsKeyRingsService) TestIamPermissions ¶

func (r *ProjectsLocationsKeyRingsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsKeyRingsTestIamPermissionsCall

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.

• resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

type ProjectsLocationsKeyRingsSetIamPolicyCall ¶

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

func (*ProjectsLocationsKeyRingsSetIamPolicyCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsSetIamPolicyCall) Do ¶

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

Do executes the "cloudkms.projects.locations.keyRings.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 (*ProjectsLocationsKeyRingsSetIamPolicyCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsSetIamPolicyCall) Header ¶

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

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

type ProjectsLocationsKeyRingsTestIamPermissionsCall ¶

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

func (*ProjectsLocationsKeyRingsTestIamPermissionsCall) Context ¶

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

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

func (*ProjectsLocationsKeyRingsTestIamPermissionsCall) Do ¶

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

Do executes the "cloudkms.projects.locations.keyRings.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 (*ProjectsLocationsKeyRingsTestIamPermissionsCall) Fields ¶

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

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

func (*ProjectsLocationsKeyRingsTestIamPermissionsCall) Header ¶

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

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

type ProjectsLocationsListCall ¶

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

func (*ProjectsLocationsListCall) Context ¶

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

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

func (*ProjectsLocationsListCall) Do ¶

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

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

func (*ProjectsLocationsListCall) Fields ¶

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

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

func (*ProjectsLocationsListCall) Filter ¶

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

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

func (*ProjectsLocationsListCall) Header ¶

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

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

func (*ProjectsLocationsListCall) IfNoneMatch ¶

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

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

func (*ProjectsLocationsListCall) PageSize ¶

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

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

func (*ProjectsLocationsListCall) PageToken ¶

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

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

func (*ProjectsLocationsListCall) Pages ¶

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

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

type ProjectsLocationsOperationsGetCall ¶

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

func (*ProjectsLocationsOperationsGetCall) Context ¶

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

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

func (*ProjectsLocationsOperationsGetCall) Do ¶

func (c *ProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "cloudkms.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 ¶

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

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

func (*ProjectsLocationsOperationsGetCall) Header ¶

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

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

func (*ProjectsLocationsOperationsGetCall) IfNoneMatch ¶

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

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 ProjectsLocationsOperationsService ¶

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

func NewProjectsLocationsOperationsService ¶

func NewProjectsLocationsOperationsService(s *Service) *ProjectsLocationsOperationsService

func (*ProjectsLocationsOperationsService) Get ¶

func (r *ProjectsLocationsOperationsService) Get(name string) *ProjectsLocationsOperationsGetCall

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.

type ProjectsLocationsService ¶

type ProjectsLocationsService struct {
    EkmConfig *ProjectsLocationsEkmConfigService

    EkmConnections *ProjectsLocationsEkmConnectionsService

    KeyHandles *ProjectsLocationsKeyHandlesService

    KeyRings *ProjectsLocationsKeyRingsService

    Operations *ProjectsLocationsOperationsService
    // contains filtered or unexported fields
}

func NewProjectsLocationsService ¶

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) GenerateRandomBytes ¶

func (r *ProjectsLocationsService) GenerateRandomBytes(location string, generaterandombytesrequest *GenerateRandomBytesRequest) *ProjectsLocationsGenerateRandomBytesCall

GenerateRandomBytes: Generate random bytes using the Cloud KMS randomness source in the provided location.

• location: The project-specific location in which to generate random bytes. For example, "projects/my-project/locations/us-central1".

func (*ProjectsLocationsService) Get ¶

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

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) GetEkmConfig ¶

func (r *ProjectsLocationsService) GetEkmConfig(name string) *ProjectsLocationsGetEkmConfigCall

GetEkmConfig: Returns the EkmConfig singleton resource for a given project and location.

- name: The name of the EkmConfig to get.

func (*ProjectsLocationsService) List ¶

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

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

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

func (*ProjectsLocationsService) UpdateEkmConfig ¶

func (r *ProjectsLocationsService) UpdateEkmConfig(name string, ekmconfig *EkmConfig) *ProjectsLocationsUpdateEkmConfigCall

UpdateEkmConfig: Updates the EkmConfig singleton resource for a given project and location.

• name: Output only. The resource name for the EkmConfig in the format `projects/*/locations/*/ekmConfig`.

type ProjectsLocationsUpdateEkmConfigCall ¶

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

func (*ProjectsLocationsUpdateEkmConfigCall) Context ¶

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

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

func (*ProjectsLocationsUpdateEkmConfigCall) Do ¶

func (c *ProjectsLocationsUpdateEkmConfigCall) Do(opts ...googleapi.CallOption) (*EkmConfig, error)

Do executes the "cloudkms.projects.locations.updateEkmConfig" call. Any non-2xx status code is an error. Response headers are in either *EkmConfig.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 (*ProjectsLocationsUpdateEkmConfigCall) Fields ¶

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

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

func (*ProjectsLocationsUpdateEkmConfigCall) Header ¶

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

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

func (*ProjectsLocationsUpdateEkmConfigCall) UpdateMask ¶

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

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

type ProjectsService ¶

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

func NewProjectsService ¶

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) ShowEffectiveAutokeyConfig ¶

func (r *ProjectsService) ShowEffectiveAutokeyConfig(parent string) *ProjectsShowEffectiveAutokeyConfigCall

ShowEffectiveAutokeyConfig: Returns the effective Cloud KMS Autokey configuration for a given project.

• parent: Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project.

type ProjectsShowEffectiveAutokeyConfigCall ¶

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

func (*ProjectsShowEffectiveAutokeyConfigCall) Context ¶

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

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

func (*ProjectsShowEffectiveAutokeyConfigCall) Do ¶

func (c *ProjectsShowEffectiveAutokeyConfigCall) Do(opts ...googleapi.CallOption) (*ShowEffectiveAutokeyConfigResponse, error)

Do executes the "cloudkms.projects.showEffectiveAutokeyConfig" call. Any non-2xx status code is an error. Response headers are in either *ShowEffectiveAutokeyConfigResponse.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 (*ProjectsShowEffectiveAutokeyConfigCall) Fields ¶

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

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

func (*ProjectsShowEffectiveAutokeyConfigCall) Header ¶

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

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

func (*ProjectsShowEffectiveAutokeyConfigCall) IfNoneMatch ¶

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

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 PublicKey ¶

PublicKey: The public keys for a given CryptoKeyVersion. Obtained via GetPublicKey.

type PublicKey struct {
    // Algorithm: The Algorithm associated with this key.
    //
    // Possible values:
    //   "CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED" - Not specified.
    //   "GOOGLE_SYMMETRIC_ENCRYPTION" - Creates symmetric encryption keys.
    //   "AES_128_GCM" - AES-GCM (Galois Counter Mode) using 128-bit keys.
    //   "AES_256_GCM" - AES-GCM (Galois Counter Mode) using 256-bit keys.
    //   "AES_128_CBC" - AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.
    //   "AES_256_CBC" - AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.
    //   "AES_128_CTR" - AES-CTR (Counter Mode) using 128-bit keys.
    //   "AES_256_CTR" - AES-CTR (Counter Mode) using 256-bit keys.
    //   "RSA_SIGN_PSS_2048_SHA256" - RSASSA-PSS 2048 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_3072_SHA256" - RSASSA-PSS 3072 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_4096_SHA256" - RSASSA-PSS 4096 bit key with a SHA256 digest.
    //   "RSA_SIGN_PSS_4096_SHA512" - RSASSA-PSS 4096 bit key with a SHA512 digest.
    //   "RSA_SIGN_PKCS1_2048_SHA256" - RSASSA-PKCS1-v1_5 with a 2048 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_3072_SHA256" - RSASSA-PKCS1-v1_5 with a 3072 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_4096_SHA256" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
    // SHA256 digest.
    //   "RSA_SIGN_PKCS1_4096_SHA512" - RSASSA-PKCS1-v1_5 with a 4096 bit key and a
    // SHA512 digest.
    //   "RSA_SIGN_RAW_PKCS1_2048" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 2048 bit key.
    //   "RSA_SIGN_RAW_PKCS1_3072" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 3072 bit key.
    //   "RSA_SIGN_RAW_PKCS1_4096" - RSASSA-PKCS1-v1_5 signing without encoding,
    // with a 4096 bit key.
    //   "RSA_DECRYPT_OAEP_2048_SHA256" - RSAES-OAEP 2048 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_3072_SHA256" - RSAES-OAEP 3072 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA256" - RSAES-OAEP 4096 bit key with a SHA256
    // digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA512" - RSAES-OAEP 4096 bit key with a SHA512
    // digest.
    //   "RSA_DECRYPT_OAEP_2048_SHA1" - RSAES-OAEP 2048 bit key with a SHA1 digest.
    //   "RSA_DECRYPT_OAEP_3072_SHA1" - RSAES-OAEP 3072 bit key with a SHA1 digest.
    //   "RSA_DECRYPT_OAEP_4096_SHA1" - RSAES-OAEP 4096 bit key with a SHA1 digest.
    //   "EC_SIGN_P256_SHA256" - ECDSA on the NIST P-256 curve with a SHA256
    // digest. Other hash functions can also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_P384_SHA384" - ECDSA on the NIST P-384 curve with a SHA384
    // digest. Other hash functions can also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_SECP256K1_SHA256" - ECDSA on the non-NIST secp256k1 curve. This
    // curve is only supported for HSM protection level. Other hash functions can
    // also be used:
    // https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms
    //   "EC_SIGN_ED25519" - EdDSA on the Curve25519 in pure mode (taking data as
    // input).
    //   "HMAC_SHA256" - HMAC-SHA256 signing with a 256 bit key.
    //   "HMAC_SHA1" - HMAC-SHA1 signing with a 160 bit key.
    //   "HMAC_SHA384" - HMAC-SHA384 signing with a 384 bit key.
    //   "HMAC_SHA512" - HMAC-SHA512 signing with a 512 bit key.
    //   "HMAC_SHA224" - HMAC-SHA224 signing with a 224 bit key.
    //   "EXTERNAL_SYMMETRIC_ENCRYPTION" - Algorithm representing symmetric
    // encryption by an external key manager.
    Algorithm string `json:"algorithm,omitempty"`
    // Name: The name of the CryptoKeyVersion public key. Provided here for
    // verification. NOTE: This field is in Beta.
    Name string `json:"name,omitempty"`
    // Pem: The public key, encoded in PEM format. For more information, see the
    // RFC 7468 (https://tools.ietf.org/html/rfc7468) sections for General
    // Considerations (https://tools.ietf.org/html/rfc7468#section-2) and [Textual
    // Encoding of Subject Public Key Info]
    // (https://tools.ietf.org/html/rfc7468#section-13).
    Pem string `json:"pem,omitempty"`
    // PemCrc32c: Integrity verification field. A CRC32C checksum of the returned
    // PublicKey.pem. An integrity check of PublicKey.pem can be performed by
    // computing the CRC32C checksum of PublicKey.pem and comparing your results to
    // this field. Discard the response in case of non-matching checksum values,
    // and perform a limited number of retries. A persistent mismatch may indicate
    // an issue in your computation of the CRC32C checksum. Note: This field is
    // defined as int64 for reasons of compatibility across different languages.
    // However, it is a non-negative integer, which will never exceed 2^32-1, and
    // can be safely downconverted to uint32 in languages that support this type.
    // NOTE: This field is in Beta.
    PemCrc32c int64 `json:"pemCrc32c,omitempty,string"`
    // ProtectionLevel: The ProtectionLevel of the CryptoKeyVersion public key.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the server.
    googleapi.ServerResponse `json:"-"`
    // 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:"-"`
}

func (*PublicKey) MarshalJSON ¶

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

type RawDecryptRequest ¶

RawDecryptRequest: Request message for KeyManagementService.RawDecrypt.

type RawDecryptRequest struct {
    // AdditionalAuthenticatedData: Optional. Optional data that must match the
    // data originally supplied in RawEncryptRequest.additional_authenticated_data.
    AdditionalAuthenticatedData string `json:"additionalAuthenticatedData,omitempty"`
    // AdditionalAuthenticatedDataCrc32c: Optional. An optional CRC32C checksum of
    // the RawDecryptRequest.additional_authenticated_data. If specified,
    // KeyManagementService will verify the integrity of the received
    // additional_authenticated_data using this checksum. KeyManagementService will
    // report an error if the checksum verification fails. If you receive a
    // checksum error, your client should verify that
    // CRC32C(additional_authenticated_data) is equal to
    // additional_authenticated_data_crc32c, and if so, perform a limited number of
    // retries. A persistent mismatch may indicate an issue in your computation of
    // the CRC32C checksum. Note: This field is defined as int64 for reasons of
    // compatibility across different languages. However, it is a non-negative
    // integer, which will never exceed 2^32-1, and can be safely downconverted to
    // uint32 in languages that support this type.
    AdditionalAuthenticatedDataCrc32c int64 `json:"additionalAuthenticatedDataCrc32c,omitempty,string"`
    // Ciphertext: Required. The encrypted data originally returned in
    // RawEncryptResponse.ciphertext.
    Ciphertext string `json:"ciphertext,omitempty"`
    // CiphertextCrc32c: Optional. An optional CRC32C checksum of the
    // RawDecryptRequest.ciphertext. If specified, KeyManagementService will verify
    // the integrity of the received ciphertext using this checksum.
    // KeyManagementService will report an error if the checksum verification
    // fails. If you receive a checksum error, your client should verify that
    // CRC32C(ciphertext) is equal to ciphertext_crc32c, and if so, perform a
    // limited number of retries. A persistent mismatch may indicate an issue in
    // your computation of the CRC32C checksum. Note: This field is defined as
    // int64 for reasons of compatibility across different languages. However, it
    // is a non-negative integer, which will never exceed 2^32-1, and can be safely
    // downconverted to uint32 in languages that support this type.
    CiphertextCrc32c int64 `json:"ciphertextCrc32c,omitempty,string"`
    // InitializationVector: Required. The initialization vector (IV) used during
    // encryption, which must match the data originally provided in
    // RawEncryptResponse.initialization_vector.
    InitializationVector string `json:"initializationVector,omitempty"`
    // InitializationVectorCrc32c: Optional. An optional CRC32C checksum of the
    // RawDecryptRequest.initialization_vector. If specified, KeyManagementService
    // will verify the integrity of the received initialization_vector using this
    // checksum. KeyManagementService will report an error if the checksum
    // verification fails. If you receive a checksum error, your client should
    // verify that CRC32C(initialization_vector) is equal to
    // initialization_vector_crc32c, and if so, perform a limited number of
    // retries. A persistent mismatch may indicate an issue in your computation of
    // the CRC32C checksum. Note: This field is defined as int64 for reasons of
    // compatibility across different languages. However, it is a non-negative
    // integer, which will never exceed 2^32-1, and can be safely downconverted to
    // uint32 in languages that support this type.
    InitializationVectorCrc32c int64 `json:"initializationVectorCrc32c,omitempty,string"`
    // TagLength: The length of the authentication tag that is appended to the end
    // of the ciphertext. If unspecified (0), the default value for the key's
    // algorithm will be used (for AES-GCM, the default value is 16).
    TagLength int64 `json:"tagLength,omitempty"`
    // ForceSendFields is a list of field names (e.g.
    // "AdditionalAuthenticatedData") 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. "AdditionalAuthenticatedData") 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 (*RawDecryptRequest) MarshalJSON ¶

func (s *RawDecryptRequest) MarshalJSON() ([]byte, error)

type RawDecryptResponse ¶

RawDecryptResponse: Response message for KeyManagementService.RawDecrypt.

type RawDecryptResponse struct {
    // Plaintext: The decrypted data.
    Plaintext string `json:"plaintext,omitempty"`
    // PlaintextCrc32c: Integrity verification field. A CRC32C checksum of the
    // returned RawDecryptResponse.plaintext. An integrity check of plaintext can
    // be performed by computing the CRC32C checksum of plaintext and comparing
    // your results to this field. Discard the response in case of non-matching
    // checksum values, and perform a limited number of retries. A persistent
    // mismatch may indicate an issue in your computation of the CRC32C checksum.
    // Note: receiving this response message indicates that KeyManagementService is
    // able to successfully decrypt the ciphertext. Note: This field is defined as
    // int64 for reasons of compatibility across different languages. However, it
    // is a non-negative integer, which will never exceed 2^32-1, and can be safely
    // downconverted to uint32 in languages that support this type.
    PlaintextCrc32c int64 `json:"plaintextCrc32c,omitempty,string"`
    // ProtectionLevel: The ProtectionLevel of the CryptoKeyVersion used in
    // decryption.
    //
    // Possible values:
    //   "PROTECTION_LEVEL_UNSPECIFIED" - Not specified.
    //   "SOFTWARE" - Crypto operations are performed in software.
    //   "HSM" - Crypto operations are performed in a Hardware Security Module.
    //   "EXTERNAL" - Crypto operations are performed by an external key manager.
    //   "EXTERNAL_VPC" - Crypto operations are performed in an EKM-over-VPC
    // backend.
    ProtectionLevel string `json:"protectionLevel,omitempty"`
    // VerifiedAdditionalAuthenticatedDataCrc32c: Integrity verification field. A
    // flag indicating whether
    // RawDecryptRequest.additional_authenticated_data_crc32c was received by
    // KeyManagementService and used for the integrity verification of
    // additional_authenticated_data. A false value of this field indicates either
    // that // RawDecryptRequest.additional_authenticated_data_crc32c was left
    // unset or that it was not delivered to KeyManagementService. If you've set
    // RawDecryptRequest.additional_authenticated_data_crc32c but this field is
    // still false, discard the response and perform a limited number of retries.
    VerifiedAdditionalAuthenticatedDataCrc32c bool `json:"verifiedAdditionalAuthenticatedDataCrc32c,omitempty"`
    // VerifiedCiphertextCrc32c: Integrity verification field. A flag indicating
    // whether RawDecryptRequest.ciphertext_crc32c was received by
    // KeyManagementService and used for the integrity verification of the
    // ciphertext. A false value of this field indicates either that
    // RawDecryptRequest.ciphertext_crc32c was left unset or that it was not
    // delivered to KeyManagementService. If you've set
    // RawDecryptRequest.ciphertext_crc32c but this field is still false, discard
    // the response and perform a limited number of retries.
    VerifiedCiphertextCrc32c bool `json:"verifiedCiphertextCrc32c,omitempty"`
    // VerifiedInitializationVectorCrc32c: Integrity verification field. A flag
    // indicating whether RawDecryptRequest.initialization_vector_crc32c was
    // received by KeyManagementService and used for the integrity verification of
    // initialization_vector. A false value of this field indicates either that
    // RawDecryptRequest.initialization_vector_crc32c was left unset or that it was
    // not delivered to KeyManagementService. If you've set
    // RawDecryptRequest.initialization_vector_crc32c but this field is still
    // false, discard the response and perform a limited number of retries.
    VerifiedInitializationVectorCrc32c bool `json:"verifiedInitializationVectorCrc32c,omitempty"`

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