Class CreateCertificateRequest.Builder (2.44.0)

public static final class CreateCertificateRequest.Builder extends GeneratedMessageV3.Builder<CreateCertificateRequest.Builder> implements CreateCertificateRequestOrBuilder

Request message for CertificateAuthorityService.CreateCertificate.

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CreateCertificateRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateCertificateRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateCertificateRequest.Builder
Overrides

build()

public CreateCertificateRequest build()
Returns
Type Description
CreateCertificateRequest

buildPartial()

public CreateCertificateRequest buildPartial()
Returns
Type Description
CreateCertificateRequest

clear()

public CreateCertificateRequest.Builder clear()
Returns
Type Description
CreateCertificateRequest.Builder
Overrides

clearCertificate()

public CreateCertificateRequest.Builder clearCertificate()

Required. A Certificate with initial field values.

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

Returns
Type Description
CreateCertificateRequest.Builder

clearCertificateId()

public CreateCertificateRequest.Builder clearCertificateId()

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
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateCertificateRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateCertificateRequest.Builder
Overrides

clearIssuingCertificateAuthorityId()

public CreateCertificateRequest.Builder clearIssuingCertificateAuthorityId()

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
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateCertificateRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateCertificateRequest.Builder
Overrides

clearParent()

public CreateCertificateRequest.Builder clearParent()

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
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

clearRequestId()

public CreateCertificateRequest.Builder clearRequestId()

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
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

clearValidateOnly()

public CreateCertificateRequest.Builder clearValidateOnly()

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
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

clone()

public CreateCertificateRequest.Builder clone()
Returns
Type Description
CreateCertificateRequest.Builder
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
Type Description
Certificate

The certificate.

getCertificateBuilder()

public Certificate.Builder getCertificateBuilder()

Required. A Certificate with initial field values.

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

Returns
Type Description
Certificate.Builder

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
Type Description
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
Type Description
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
Type Description
CertificateOrBuilder

getDefaultInstanceForType()

public CreateCertificateRequest getDefaultInstanceForType()
Returns
Type Description
CreateCertificateRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for parent.

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
Type Description
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
Type Description
ByteString

The bytes for requestId.

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
Type Description
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
Type Description
boolean

Whether the certificate field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCertificate(Certificate value)

public CreateCertificateRequest.Builder mergeCertificate(Certificate value)

Required. A Certificate with initial field values.

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

Parameter
Name Description
value Certificate
Returns
Type Description
CreateCertificateRequest.Builder

mergeFrom(CreateCertificateRequest other)

public CreateCertificateRequest.Builder mergeFrom(CreateCertificateRequest other)
Parameter
Name Description
other CreateCertificateRequest
Returns
Type Description
CreateCertificateRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CreateCertificateRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateCertificateRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CreateCertificateRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CreateCertificateRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateCertificateRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateCertificateRequest.Builder
Overrides

setCertificate(Certificate value)

public CreateCertificateRequest.Builder setCertificate(Certificate value)

Required. A Certificate with initial field values.

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

Parameter
Name Description
value Certificate
Returns
Type Description
CreateCertificateRequest.Builder

setCertificate(Certificate.Builder builderForValue)

public CreateCertificateRequest.Builder setCertificate(Certificate.Builder builderForValue)

Required. A Certificate with initial field values.

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

Parameter
Name Description
builderForValue Certificate.Builder
Returns
Type Description
CreateCertificateRequest.Builder

setCertificateId(String value)

public CreateCertificateRequest.Builder setCertificateId(String value)

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

Parameter
Name Description
value String

The certificateId to set.
Returns
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

setCertificateIdBytes(ByteString value)

public CreateCertificateRequest.Builder setCertificateIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for certificateId to set.
Returns
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateCertificateRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateCertificateRequest.Builder
Overrides

setIssuingCertificateAuthorityId(String value)

public CreateCertificateRequest.Builder setIssuingCertificateAuthorityId(String value)

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

Parameter
Name Description
value String

The issuingCertificateAuthorityId to set.
Returns
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

setIssuingCertificateAuthorityIdBytes(ByteString value)

public CreateCertificateRequest.Builder setIssuingCertificateAuthorityIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for issuingCertificateAuthorityId to set.
Returns
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

setParent(String value)

public CreateCertificateRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateCertificateRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public CreateCertificateRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateCertificateRequest.Builder
Overrides

setRequestId(String value)

public CreateCertificateRequest.Builder setRequestId(String value)

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

Parameter
Name Description
value String

The requestId to set.
Returns
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public CreateCertificateRequest.Builder setRequestIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for requestId to set.
Returns
Type Description
CreateCertificateRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateCertificateRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateCertificateRequest.Builder
Overrides

setValidateOnly(boolean value)

public CreateCertificateRequest.Builder setValidateOnly(boolean value)

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

Parameter
Name Description
value boolean

The validateOnly to set.
Returns
Type Description
CreateCertificateRequest.Builder

This builder for chaining.