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

Class CreateCertificateRequest

  • All Implemented Interfaces:
    CreateCertificateRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CreateCertificateRequest
extends com.google.protobuf.GeneratedMessageV3
implements CreateCertificateRequestOrBuilder
     Request message for
 [CertificateAuthorityService.CreateCertificate][google.cloud.security.privateca.v1.CertificateAuthorityService.CreateCertificate].
    Protobuf type google.cloud.security.privateca.v1.CreateCertificateRequest
    See Also:
    Serialized Form

    • Field Detail

      • CERTIFICATE_ID_FIELD_NUMBER

        public static final int CERTIFICATE_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CERTIFICATE_FIELD_NUMBER

        public static final int CERTIFICATE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_ID_FIELD_NUMBER

        public static final int REQUEST_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VALIDATE_ONLY_FIELD_NUMBER

        public static final int VALIDATE_ONLY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ISSUING_CERTIFICATE_AUTHORITY_ID_FIELD_NUMBER

        public static final int ISSUING_CERTIFICATE_AUTHORITY_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface CreateCertificateRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface CreateCertificateRequestOrBuilder
        Returns:
        The bytes for parent.

      • getCertificateId

        public 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];
        Specified by:
        getCertificateId in interface CreateCertificateRequestOrBuilder
        Returns:
        The certificateId.

      • getCertificateIdBytes

        public 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];
        Specified by:
        getCertificateIdBytes in interface CreateCertificateRequestOrBuilder
        Returns:
        The bytes for certificateId.

      • hasCertificate

        public 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];
        Specified by:
        hasCertificate in interface CreateCertificateRequestOrBuilder
        Returns:
        Whether the certificate field is set.

      • getCertificate

        public 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];
        Specified by:
        getCertificate in interface CreateCertificateRequestOrBuilder
        Returns:
        The certificate.

      • getRequestId

        public 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];
        Specified by:
        getRequestId in interface CreateCertificateRequestOrBuilder
        Returns:
        The requestId.

      • getRequestIdBytes

        public 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];
        Specified by:
        getRequestIdBytes in interface CreateCertificateRequestOrBuilder
        Returns:
        The bytes for requestId.

      • getValidateOnly

        public 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];
        Specified by:
        getValidateOnly in interface CreateCertificateRequestOrBuilder
        Returns:
        The validateOnly.

      • getIssuingCertificateAuthorityId

        public 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];
        Specified by:
        getIssuingCertificateAuthorityId in interface CreateCertificateRequestOrBuilder
        Returns:
        The issuingCertificateAuthorityId.

      • getIssuingCertificateAuthorityIdBytes

        public 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];
        Specified by:
        getIssuingCertificateAuthorityIdBytes in interface CreateCertificateRequestOrBuilder
        Returns:
        The bytes for issuingCertificateAuthorityId.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CreateCertificateRequest parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateCertificateRequest parseFrom​(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateCertificateRequest parseFrom​(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateCertificateRequest parseFrom​(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateCertificateRequest parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CreateCertificateRequest parseFrom​(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public CreateCertificateRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CreateCertificateRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CreateCertificateRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<CreateCertificateRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CreateCertificateRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder