Class CreateCertificateRequest (2.37.0)

public final class CreateCertificateRequest extends GeneratedMessageV3 implements CreateCertificateRequestOrBuilder

Request message for CertificateAuthorityService.CreateCertificate.

Protobuf type google.cloud.security.privateca.v1.CreateCertificateRequest

Static Fields

CERTIFICATE_FIELD_NUMBER

public static final int CERTIFICATE_FIELD_NUMBER
Field Value
TypeDescription
int

CERTIFICATE_ID_FIELD_NUMBER

public static final int CERTIFICATE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

ISSUING_CERTIFICATE_AUTHORITY_ID_FIELD_NUMBER

public static final int ISSUING_CERTIFICATE_AUTHORITY_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
TypeDescription
int

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateCertificateRequest getDefaultInstance()
Returns
TypeDescription
CreateCertificateRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateCertificateRequest.Builder newBuilder()
Returns
TypeDescription
CreateCertificateRequest.Builder

newBuilder(CreateCertificateRequest prototype)

public static CreateCertificateRequest.Builder newBuilder(CreateCertificateRequest prototype)
Parameter
NameDescription
prototypeCreateCertificateRequest
Returns
TypeDescription
CreateCertificateRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateCertificateRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateCertificateRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateCertificateRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateCertificateRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateCertificateRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateCertificateRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateCertificateRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateCertificateRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateCertificateRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateCertificateRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateCertificateRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateCertificateRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateCertificateRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateCertificateRequest> parser()
Returns
TypeDescription
Parser<CreateCertificateRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCertificate()

public Certificate getCertificate()

Required. A Certificate with initial field values.

.google.cloud.security.privateca.v1.Certificate certificate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Certificate

The certificate.

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 in the Enterprise [CertificateAuthority.Tier][], but is optional and its value is ignored otherwise.

string certificate_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The certificateId.

getCertificateIdBytes()

public 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 in the Enterprise [CertificateAuthority.Tier][], but is optional and its value is ignored otherwise.

string certificate_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for certificateId.

getCertificateOrBuilder()

public CertificateOrBuilder getCertificateOrBuilder()

Required. A Certificate with initial field values.

.google.cloud.security.privateca.v1.Certificate certificate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CertificateOrBuilder

getDefaultInstanceForType()

public CreateCertificateRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateCertificateRequest

getIssuingCertificateAuthorityId()

public String getIssuingCertificateAuthorityId()

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

string issuing_certificate_authority_id = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The issuingCertificateAuthorityId.

getIssuingCertificateAuthorityIdBytes()

public ByteString getIssuingCertificateAuthorityIdBytes()

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

string issuing_certificate_authority_id = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for issuingCertificateAuthorityId.

getParent()

public String getParent()

Required. The resource name of the CaPool associated with the Certificate, in the format projects/*/locations/*/caPools/*.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the CaPool associated with the Certificate, in the format projects/*/locations/*/caPools/*.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateCertificateRequest> getParserForType()
Returns
TypeDescription
Parser<CreateCertificateRequest>
Overrides

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];

Returns
TypeDescription
String

The requestId.

getRequestIdBytes()

public 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
TypeDescription
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getValidateOnly()

public boolean getValidateOnly()

Optional. If this is true, no Certificate resource will be persisted regardless of the CaPool's tier, and the returned Certificate will not contain the pem_certificate field.

bool validate_only = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The validateOnly.

hasCertificate()

public boolean hasCertificate()

Required. A Certificate with initial field values.

.google.cloud.security.privateca.v1.Certificate certificate = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the certificate field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateCertificateRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateCertificateRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateCertificateRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateCertificateRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateCertificateRequest.Builder toBuilder()
Returns
TypeDescription
CreateCertificateRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException