/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/security/privateca/v1/resources.proto
package com.google.cloud.security.privateca.v1;
public interface CertificateOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.security.privateca.v1.Certificate)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The resource name for this
* [Certificate][google.cloud.security.privateca.v1.Certificate] in the format
* `projects/*/locations/*/caPools/*/certificates/*`.
*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
*
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The resource name for this
* [Certificate][google.cloud.security.privateca.v1.Certificate] in the format
* `projects/*/locations/*/caPools/*/certificates/*`.
*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Immutable. A pem-encoded X.509 certificate signing request (CSR).
*
*
* string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return Whether the pemCsr field is set.
*/
boolean hasPemCsr();
/**
*
*
*
* Immutable. A pem-encoded X.509 certificate signing request (CSR).
*
*
* string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The pemCsr.
*/
java.lang.String getPemCsr();
/**
*
*
*
* Immutable. A pem-encoded X.509 certificate signing request (CSR).
*
*
* string pem_csr = 2 [(.google.api.field_behavior) = IMMUTABLE];
*
* @return The bytes for pemCsr.
*/
com.google.protobuf.ByteString getPemCsrBytes();
/**
*
*
*
* Immutable. A description of the certificate and key that does not require
* X.509 or ASN.1.
*
*
*
* .google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return Whether the config field is set.
*/
boolean hasConfig();
/**
*
*
*
* Immutable. A description of the certificate and key that does not require
* X.509 or ASN.1.
*
*
*
* .google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The config.
*/
com.google.cloud.security.privateca.v1.CertificateConfig getConfig();
/**
*
*
*
* Immutable. A description of the certificate and key that does not require
* X.509 or ASN.1.
*
*
*
* .google.cloud.security.privateca.v1.CertificateConfig config = 3 [(.google.api.field_behavior) = IMMUTABLE];
*
*/
com.google.cloud.security.privateca.v1.CertificateConfigOrBuilder getConfigOrBuilder();
/**
*
*
*
* Output only. The resource name of the issuing
* [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
* in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
*
*
*
* string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
*
*
* @return The issuerCertificateAuthority.
*/
java.lang.String getIssuerCertificateAuthority();
/**
*
*
*
* Output only. The resource name of the issuing
* [CertificateAuthority][google.cloud.security.privateca.v1.CertificateAuthority]
* in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`.
*
*
*
* string issuer_certificate_authority = 4 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for issuerCertificateAuthority.
*/
com.google.protobuf.ByteString getIssuerCertificateAuthorityBytes();
/**
*
*
*
* Required. Immutable. The desired lifetime of a certificate. Used to create
* the "not_before_time" and "not_after_time" fields inside an X.509
* certificate. Note that the lifetime may be truncated if it would extend
* past the life of any certificate authority in the issuing chain.
*
*
*
* .google.protobuf.Duration lifetime = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
*
*
* @return Whether the lifetime field is set.
*/
boolean hasLifetime();
/**
*
*
*
* Required. Immutable. The desired lifetime of a certificate. Used to create
* the "not_before_time" and "not_after_time" fields inside an X.509
* certificate. Note that the lifetime may be truncated if it would extend
* past the life of any certificate authority in the issuing chain.
*
*
*
* .google.protobuf.Duration lifetime = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The lifetime.
*/
com.google.protobuf.Duration getLifetime();
/**
*
*
*
* Required. Immutable. The desired lifetime of a certificate. Used to create
* the "not_before_time" and "not_after_time" fields inside an X.509
* certificate. Note that the lifetime may be truncated if it would extend
* past the life of any certificate authority in the issuing chain.
*
*
*
* .google.protobuf.Duration lifetime = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
*
*/
com.google.protobuf.DurationOrBuilder getLifetimeOrBuilder();
/**
*
*
*
* Immutable. The resource name for a
* [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]
* used to issue this certificate, in the format
* `projects/*/locations/*/certificateTemplates/*`.
* If this is specified, the caller must have the necessary permission to
* use this template. If this is omitted, no template will be used.
* This template must be in the same location as the
* [Certificate][google.cloud.security.privateca.v1.Certificate].
*
*
*
* string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
*
*
* @return The certificateTemplate.
*/
java.lang.String getCertificateTemplate();
/**
*
*
*
* Immutable. The resource name for a
* [CertificateTemplate][google.cloud.security.privateca.v1.CertificateTemplate]
* used to issue this certificate, in the format
* `projects/*/locations/*/certificateTemplates/*`.
* If this is specified, the caller must have the necessary permission to
* use this template. If this is omitted, no template will be used.
* This template must be in the same location as the
* [Certificate][google.cloud.security.privateca.v1.Certificate].
*
*
*
* string certificate_template = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for certificateTemplate.
*/
com.google.protobuf.ByteString getCertificateTemplateBytes();
/**
*
*
*
* Immutable. Specifies how the
* [Certificate][google.cloud.security.privateca.v1.Certificate]'s identity
* fields are to be decided. If this is omitted, the `DEFAULT` subject mode
* will be used.
*
*
*
* .google.cloud.security.privateca.v1.SubjectRequestMode subject_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The enum numeric value on the wire for subjectMode.
*/
int getSubjectModeValue();
/**
*
*
*
* Immutable. Specifies how the
* [Certificate][google.cloud.security.privateca.v1.Certificate]'s identity
* fields are to be decided. If this is omitted, the `DEFAULT` subject mode
* will be used.
*
*
*
* .google.cloud.security.privateca.v1.SubjectRequestMode subject_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];
*
*
* @return The subjectMode.
*/
com.google.cloud.security.privateca.v1.SubjectRequestMode getSubjectMode();
/**
*
*
*
* Output only. Details regarding the revocation of this
* [Certificate][google.cloud.security.privateca.v1.Certificate]. This
* [Certificate][google.cloud.security.privateca.v1.Certificate] is considered
* revoked if and only if this field is present.
*
*
*
* .google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the revocationDetails field is set.
*/
boolean hasRevocationDetails();
/**
*
*
*
* Output only. Details regarding the revocation of this
* [Certificate][google.cloud.security.privateca.v1.Certificate]. This
* [Certificate][google.cloud.security.privateca.v1.Certificate] is considered
* revoked if and only if this field is present.
*
*
*
* .google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The revocationDetails.
*/
com.google.cloud.security.privateca.v1.Certificate.RevocationDetails getRevocationDetails();
/**
*
*
*
* Output only. Details regarding the revocation of this
* [Certificate][google.cloud.security.privateca.v1.Certificate]. This
* [Certificate][google.cloud.security.privateca.v1.Certificate] is considered
* revoked if and only if this field is present.
*
*
*
* .google.cloud.security.privateca.v1.Certificate.RevocationDetails revocation_details = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.security.privateca.v1.Certificate.RevocationDetailsOrBuilder
getRevocationDetailsOrBuilder();
/**
*
*
*
* Output only. The pem-encoded, signed X.509 certificate.
*
*
* string pem_certificate = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The pemCertificate.
*/
java.lang.String getPemCertificate();
/**
*
*
*
* Output only. The pem-encoded, signed X.509 certificate.
*
*
* string pem_certificate = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for pemCertificate.
*/
com.google.protobuf.ByteString getPemCertificateBytes();
/**
*
*
*
* Output only. A structured description of the issued X.509 certificate.
*
*
*
* .google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the certificateDescription field is set.
*/
boolean hasCertificateDescription();
/**
*
*
*
* Output only. A structured description of the issued X.509 certificate.
*
*
*
* .google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The certificateDescription.
*/
com.google.cloud.security.privateca.v1.CertificateDescription getCertificateDescription();
/**
*
*
*
* Output only. A structured description of the issued X.509 certificate.
*
*
*
* .google.cloud.security.privateca.v1.CertificateDescription certificate_description = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.security.privateca.v1.CertificateDescriptionOrBuilder
getCertificateDescriptionOrBuilder();
/**
*
*
*
* Output only. The chain that may be used to verify the X.509 certificate.
* Expected to be in issuer-to-root order according to RFC 5246.
*
*
* repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return A list containing the pemCertificateChain.
*/
java.util.List getPemCertificateChainList();
/**
*
*
*
* Output only. The chain that may be used to verify the X.509 certificate.
* Expected to be in issuer-to-root order according to RFC 5246.
*
*
* repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The count of pemCertificateChain.
*/
int getPemCertificateChainCount();
/**
*
*
*
* Output only. The chain that may be used to verify the X.509 certificate.
* Expected to be in issuer-to-root order according to RFC 5246.
*
*
* repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @param index The index of the element to return.
* @return The pemCertificateChain at the given index.
*/
java.lang.String getPemCertificateChain(int index);
/**
*
*
*
* Output only. The chain that may be used to verify the X.509 certificate.
* Expected to be in issuer-to-root order according to RFC 5246.
*
*
* repeated string pem_certificate_chain = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @param index The index of the value to return.
* @return The bytes of the pemCertificateChain at the given index.
*/
com.google.protobuf.ByteString getPemCertificateChainBytes(int index);
/**
*
*
*
* Output only. The time at which this
* [Certificate][google.cloud.security.privateca.v1.Certificate] was created.
*
*
* .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time at which this
* [Certificate][google.cloud.security.privateca.v1.Certificate] was created.
*
*
* .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time at which this
* [Certificate][google.cloud.security.privateca.v1.Certificate] was created.
*
*
* .google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The time at which this
* [Certificate][google.cloud.security.privateca.v1.Certificate] was updated.
*
*
* .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The time at which this
* [Certificate][google.cloud.security.privateca.v1.Certificate] was updated.
*
*
* .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. The time at which this
* [Certificate][google.cloud.security.privateca.v1.Certificate] was updated.
*
*
* .google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Optional. Labels with user-defined metadata.
*
*
* map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. Labels with user-defined metadata.
*
*
* map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. Labels with user-defined metadata.
*
*
* map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. Labels with user-defined metadata.
*
*
* map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. Labels with user-defined metadata.
*
*
* map<string, string> labels = 14 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
public com.google.cloud.security.privateca.v1.Certificate.CertificateConfigCase
getCertificateConfigCase();
}