Interface CreateCertificateRequestOrBuilder (2.5.0)

public interface CreateCertificateRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCertificate()

public abstract 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 abstract 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 abstract 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 abstract 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

getIssuingCertificateAuthorityId()

public abstract 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 abstract 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 abstract 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 abstract 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.

getRequestId()

public abstract 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 abstract 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.

getValidateOnly()

public abstract 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 abstract 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.