Package com.google.cloud.security.privateca.v1

Interface CreateCertificateRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CreateCertificateRequest, CreateCertificateRequest.Builder
    public interface CreateCertificateRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getParent

        String getParent()
         Required. The resource name of the
 [CaPool][google.cloud.security.privateca.v1.CaPool] associated with the
 [Certificate][google.cloud.security.privateca.v1.Certificate], in the
 format `projects/*/locations/*/caPools/*`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the
 [CaPool][google.cloud.security.privateca.v1.CaPool] associated with the
 [Certificate][google.cloud.security.privateca.v1.Certificate], in the
 format `projects/*/locations/*/caPools/*`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getCertificateId

        String getCertificateId()
         Optional. It must be unique within a location and match the regular
 expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 in the Enterprise [CertificateAuthority.Tier][], but is optional and its
 value is ignored otherwise.
        string certificate_id = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The certificateId.

      • getCertificateIdBytes

        com.google.protobuf.ByteString getCertificateIdBytes()
         Optional. It must be unique within a location and match the regular
 expression `[a-zA-Z0-9_-]{1,63}`. This field is required when using a
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 in the Enterprise [CertificateAuthority.Tier][], but is optional and its
 value is ignored otherwise.
        string certificate_id = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for certificateId.

      • hasCertificate

        boolean hasCertificate()
         Required. A [Certificate][google.cloud.security.privateca.v1.Certificate]
 with initial field values.
        .google.cloud.security.privateca.v1.Certificate certificate = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the certificate field is set.

      • getCertificate

        Certificate getCertificate()
         Required. A [Certificate][google.cloud.security.privateca.v1.Certificate]
 with initial field values.
        .google.cloud.security.privateca.v1.Certificate certificate = 3 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The certificate.

      • getCertificateOrBuilder

        CertificateOrBuilder getCertificateOrBuilder()
         Required. A [Certificate][google.cloud.security.privateca.v1.Certificate]
 with initial field values.
        .google.cloud.security.privateca.v1.Certificate certificate = 3 [(.google.api.field_behavior) = REQUIRED];

      • getRequestId

        String getRequestId()
         Optional. An ID to identify requests. Specify a unique request ID so that
 if you must retry your request, the server will know to ignore the request
 if it has already been completed. The server will guarantee that for at
 least 60 minutes since the first request.

 For example, consider a situation where you make an initial request and the
 request times out. If you make the request again with the same request ID,
 the server can check if original operation with the same request ID was
 received, and if so, will ignore the second request. This prevents clients
 from accidentally creating duplicate commitments.

 The request ID must be a valid UUID with the exception that zero UUID is
 not supported (00000000-0000-0000-0000-000000000000).
        string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The requestId.

      • getRequestIdBytes

        com.google.protobuf.ByteString getRequestIdBytes()
         Optional. An ID to identify requests. Specify a unique request ID so that
 if you must retry your request, the server will know to ignore the request
 if it has already been completed. The server will guarantee that for at
 least 60 minutes since the first request.

 For example, consider a situation where you make an initial request and the
 request times out. If you make the request again with the same request ID,
 the server can check if original operation with the same request ID was
 received, and if so, will ignore the second request. This prevents clients
 from accidentally creating duplicate commitments.

 The request ID must be a valid UUID with the exception that zero UUID is
 not supported (00000000-0000-0000-0000-000000000000).
        string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for requestId.

      • getValidateOnly

        boolean getValidateOnly()
         Optional. If this is true, no
 [Certificate][google.cloud.security.privateca.v1.Certificate] resource will
 be persisted regardless of the
 [CaPool][google.cloud.security.privateca.v1.CaPool]'s
 [tier][google.cloud.security.privateca.v1.CaPool.tier], and the returned
 [Certificate][google.cloud.security.privateca.v1.Certificate] will not
 contain the
 [pem_certificate][google.cloud.security.privateca.v1.Certificate.pem_certificate]
 field.
        bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The validateOnly.

      • getIssuingCertificateAuthorityId

        String getIssuingCertificateAuthorityId()
         Optional. The resource ID of the
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 that should issue the certificate.  This optional field will ignore the
 load-balancing scheme of the Pool and directly issue the certificate from
 the CA with the specified ID, contained in the same
 [CaPool][google.cloud.security.privateca.v1.CaPool] referenced by `parent`.
 Per-CA quota rules apply. If left empty, a
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 will be chosen from the [CaPool][google.cloud.security.privateca.v1.CaPool]
 by the service. For example, to issue a
 [Certificate][google.cloud.security.privateca.v1.Certificate] from a
 Certificate Authority with resource name
 "projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthorities/my-ca",
 you can set the
 [parent][google.cloud.security.privateca.v1.CreateCertificateRequest.parent]
 to "projects/my-project/locations/us-central1/caPools/my-pool" and the
 [issuing_certificate_authority_id][google.cloud.security.privateca.v1.CreateCertificateRequest.issuing_certificate_authority_id]
 to "my-ca".
        string issuing_certificate_authority_id = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The issuingCertificateAuthorityId.

      • getIssuingCertificateAuthorityIdBytes

        com.google.protobuf.ByteString getIssuingCertificateAuthorityIdBytes()
         Optional. The resource ID of the
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 that should issue the certificate.  This optional field will ignore the
 load-balancing scheme of the Pool and directly issue the certificate from
 the CA with the specified ID, contained in the same
 [CaPool][google.cloud.security.privateca.v1.CaPool] referenced by `parent`.
 Per-CA quota rules apply. If left empty, a
 [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
 will be chosen from the [CaPool][google.cloud.security.privateca.v1.CaPool]
 by the service. For example, to issue a
 [Certificate][google.cloud.security.privateca.v1.Certificate] from a
 Certificate Authority with resource name
 "projects/my-project/locations/us-central1/caPools/my-pool/certificateAuthorities/my-ca",
 you can set the
 [parent][google.cloud.security.privateca.v1.CreateCertificateRequest.parent]
 to "projects/my-project/locations/us-central1/caPools/my-pool" and the
 [issuing_certificate_authority_id][google.cloud.security.privateca.v1.CreateCertificateRequest.issuing_certificate_authority_id]
 to "my-ca".
        string issuing_certificate_authority_id = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for issuingCertificateAuthorityId.