Class CertificateAuthority.CertificateAuthorityPolicy (2.23.0)

public static final class CertificateAuthority.CertificateAuthorityPolicy extends GeneratedMessageV3 implements CertificateAuthority.CertificateAuthorityPolicyOrBuilder

The issuing policy for a CertificateAuthority. Certificates will not be successfully issued from this CertificateAuthority if they violate the policy.

Protobuf type google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > CertificateAuthority.CertificateAuthorityPolicy

Static Fields

ALLOWED_COMMON_NAMES_FIELD_NUMBER

public static final int ALLOWED_COMMON_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

ALLOWED_CONFIG_LIST_FIELD_NUMBER

public static final int ALLOWED_CONFIG_LIST_FIELD_NUMBER
Field Value
TypeDescription
int

ALLOWED_ISSUANCE_MODES_FIELD_NUMBER

public static final int ALLOWED_ISSUANCE_MODES_FIELD_NUMBER
Field Value
TypeDescription
int

ALLOWED_LOCATIONS_AND_ORGANIZATIONS_FIELD_NUMBER

public static final int ALLOWED_LOCATIONS_AND_ORGANIZATIONS_FIELD_NUMBER
Field Value
TypeDescription
int

ALLOWED_SANS_FIELD_NUMBER

public static final int ALLOWED_SANS_FIELD_NUMBER
Field Value
TypeDescription
int

MAXIMUM_LIFETIME_FIELD_NUMBER

public static final int MAXIMUM_LIFETIME_FIELD_NUMBER
Field Value
TypeDescription
int

OVERWRITE_CONFIG_VALUES_FIELD_NUMBER

public static final int OVERWRITE_CONFIG_VALUES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CertificateAuthority.CertificateAuthorityPolicy getDefaultInstance()
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy

getDescriptor()

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

newBuilder()

public static CertificateAuthority.CertificateAuthorityPolicy.Builder newBuilder()
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.Builder

newBuilder(CertificateAuthority.CertificateAuthorityPolicy prototype)

public static CertificateAuthority.CertificateAuthorityPolicy.Builder newBuilder(CertificateAuthority.CertificateAuthorityPolicy prototype)
Parameter
NameDescription
prototypeCertificateAuthority.CertificateAuthorityPolicy
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.Builder

parseDelimitedFrom(InputStream input)

public static CertificateAuthority.CertificateAuthorityPolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<CertificateAuthority.CertificateAuthorityPolicy> parser()
Returns
TypeDescription
Parser<CertificateAuthorityPolicy>

Methods

equals(Object obj)

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

getAllowedCommonNames(int index)

public String getAllowedCommonNames(int index)

Optional. If any value is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed value. If no value is specified, all values will be allowed for this fied. Glob patterns are also supported.

repeated string allowed_common_names = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The allowedCommonNames at the given index.

getAllowedCommonNamesBytes(int index)

public ByteString getAllowedCommonNamesBytes(int index)

Optional. If any value is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed value. If no value is specified, all values will be allowed for this fied. Glob patterns are also supported.

repeated string allowed_common_names = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the allowedCommonNames at the given index.

getAllowedCommonNamesCount()

public int getAllowedCommonNamesCount()

Optional. If any value is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed value. If no value is specified, all values will be allowed for this fied. Glob patterns are also supported.

repeated string allowed_common_names = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The count of allowedCommonNames.

getAllowedCommonNamesList()

public ProtocolStringList getAllowedCommonNamesList()

Optional. If any value is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed value. If no value is specified, all values will be allowed for this fied. Glob patterns are also supported.

repeated string allowed_common_names = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ProtocolStringList

A list containing the allowedCommonNames.

getAllowedConfigList()

public CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigList getAllowedConfigList()

Optional. All Certificates issued by the CertificateAuthority must match at least one listed ReusableConfigWrapper in the list.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigList allowed_config_list = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigList

The allowedConfigList.

getAllowedConfigListOrBuilder()

public CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigListOrBuilder getAllowedConfigListOrBuilder()

Optional. All Certificates issued by the CertificateAuthority must match at least one listed ReusableConfigWrapper in the list.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigList allowed_config_list = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigListOrBuilder

getAllowedIssuanceModes()

public CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes getAllowedIssuanceModes()

Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes allowed_issuance_modes = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes

The allowedIssuanceModes.

getAllowedIssuanceModesOrBuilder()

public CertificateAuthority.CertificateAuthorityPolicy.IssuanceModesOrBuilder getAllowedIssuanceModesOrBuilder()

Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes allowed_issuance_modes = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.IssuanceModesOrBuilder

getAllowedLocationsAndOrganizations(int index)

public Subject getAllowedLocationsAndOrganizations(int index)

Optional. If any Subject is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed Subject. If a Subject has an empty field, any value will be allowed for that field.

repeated .google.cloud.security.privateca.v1beta1.Subject allowed_locations_and_organizations = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
Subject

getAllowedLocationsAndOrganizationsCount()

public int getAllowedLocationsAndOrganizationsCount()

Optional. If any Subject is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed Subject. If a Subject has an empty field, any value will be allowed for that field.

repeated .google.cloud.security.privateca.v1beta1.Subject allowed_locations_and_organizations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

getAllowedLocationsAndOrganizationsList()

public List<Subject> getAllowedLocationsAndOrganizationsList()

Optional. If any Subject is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed Subject. If a Subject has an empty field, any value will be allowed for that field.

repeated .google.cloud.security.privateca.v1beta1.Subject allowed_locations_and_organizations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<Subject>

getAllowedLocationsAndOrganizationsOrBuilder(int index)

public SubjectOrBuilder getAllowedLocationsAndOrganizationsOrBuilder(int index)

Optional. If any Subject is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed Subject. If a Subject has an empty field, any value will be allowed for that field.

repeated .google.cloud.security.privateca.v1beta1.Subject allowed_locations_and_organizations = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
indexint
Returns
TypeDescription
SubjectOrBuilder

getAllowedLocationsAndOrganizationsOrBuilderList()

public List<? extends SubjectOrBuilder> getAllowedLocationsAndOrganizationsOrBuilderList()

Optional. If any Subject is specified here, then all Certificates issued by the CertificateAuthority must match at least one listed Subject. If a Subject has an empty field, any value will be allowed for that field.

repeated .google.cloud.security.privateca.v1beta1.Subject allowed_locations_and_organizations = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
List<? extends com.google.cloud.security.privateca.v1beta1.SubjectOrBuilder>

getAllowedSans()

public CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames getAllowedSans()

Optional. If a AllowedSubjectAltNames is specified here, then all Certificates issued by the CertificateAuthority must match AllowedSubjectAltNames. If no value or an empty value is specified, any value will be allowed for the SubjectAltNames field.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames allowed_sans = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames

The allowedSans.

getAllowedSansOrBuilder()

public CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNamesOrBuilder getAllowedSansOrBuilder()

Optional. If a AllowedSubjectAltNames is specified here, then all Certificates issued by the CertificateAuthority must match AllowedSubjectAltNames. If no value or an empty value is specified, any value will be allowed for the SubjectAltNames field.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames allowed_sans = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNamesOrBuilder

getConfigPolicyCase()

public CertificateAuthority.CertificateAuthorityPolicy.ConfigPolicyCase getConfigPolicyCase()
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.ConfigPolicyCase

getDefaultInstanceForType()

public CertificateAuthority.CertificateAuthorityPolicy getDefaultInstanceForType()
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy

getMaximumLifetime()

public Duration getMaximumLifetime()

Optional. The maximum lifetime allowed by the CertificateAuthority. Note that if the any part if the issuing chain expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated.

.google.protobuf.Duration maximum_lifetime = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Duration

The maximumLifetime.

getMaximumLifetimeOrBuilder()

public DurationOrBuilder getMaximumLifetimeOrBuilder()

Optional. The maximum lifetime allowed by the CertificateAuthority. Note that if the any part if the issuing chain expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated.

.google.protobuf.Duration maximum_lifetime = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DurationOrBuilder

getOverwriteConfigValues()

public ReusableConfigWrapper getOverwriteConfigValues()

Optional. All Certificates issued by the CertificateAuthority will use the provided configuration values, overwriting any requested configuration values.

.google.cloud.security.privateca.v1beta1.ReusableConfigWrapper overwrite_config_values = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ReusableConfigWrapper

The overwriteConfigValues.

getOverwriteConfigValuesOrBuilder()

public ReusableConfigWrapperOrBuilder getOverwriteConfigValuesOrBuilder()

Optional. All Certificates issued by the CertificateAuthority will use the provided configuration values, overwriting any requested configuration values.

.google.cloud.security.privateca.v1beta1.ReusableConfigWrapper overwrite_config_values = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ReusableConfigWrapperOrBuilder

getParserForType()

public Parser<CertificateAuthority.CertificateAuthorityPolicy> getParserForType()
Returns
TypeDescription
Parser<CertificateAuthorityPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasAllowedConfigList()

public boolean hasAllowedConfigList()

Optional. All Certificates issued by the CertificateAuthority must match at least one listed ReusableConfigWrapper in the list.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedConfigList allowed_config_list = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the allowedConfigList field is set.

hasAllowedIssuanceModes()

public boolean hasAllowedIssuanceModes()

Optional. If specified, then only methods allowed in the IssuanceModes may be used to issue Certificates.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IssuanceModes allowed_issuance_modes = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the allowedIssuanceModes field is set.

hasAllowedSans()

public boolean hasAllowedSans()

Optional. If a AllowedSubjectAltNames is specified here, then all Certificates issued by the CertificateAuthority must match AllowedSubjectAltNames. If no value or an empty value is specified, any value will be allowed for the SubjectAltNames field.

.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNames allowed_sans = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the allowedSans field is set.

hasMaximumLifetime()

public boolean hasMaximumLifetime()

Optional. The maximum lifetime allowed by the CertificateAuthority. Note that if the any part if the issuing chain expires before a Certificate's requested maximum_lifetime, the effective lifetime will be explicitly truncated.

.google.protobuf.Duration maximum_lifetime = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the maximumLifetime field is set.

hasOverwriteConfigValues()

public boolean hasOverwriteConfigValues()

Optional. All Certificates issued by the CertificateAuthority will use the provided configuration values, overwriting any requested configuration values.

.google.cloud.security.privateca.v1beta1.ReusableConfigWrapper overwrite_config_values = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the overwriteConfigValues 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 CertificateAuthority.CertificateAuthorityPolicy.Builder newBuilderForType()
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public CertificateAuthority.CertificateAuthorityPolicy.Builder toBuilder()
Returns
TypeDescription
CertificateAuthority.CertificateAuthorityPolicy.Builder

writeTo(CodedOutputStream output)

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