Class CertificateAuthority.CertificateAuthorityPolicy (2.45.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
Type Description
int

ALLOWED_CONFIG_LIST_FIELD_NUMBER

public static final int ALLOWED_CONFIG_LIST_FIELD_NUMBER
Field Value
Type Description
int

ALLOWED_ISSUANCE_MODES_FIELD_NUMBER

public static final int ALLOWED_ISSUANCE_MODES_FIELD_NUMBER
Field Value
Type Description
int

ALLOWED_LOCATIONS_AND_ORGANIZATIONS_FIELD_NUMBER

public static final int ALLOWED_LOCATIONS_AND_ORGANIZATIONS_FIELD_NUMBER
Field Value
Type Description
int

ALLOWED_SANS_FIELD_NUMBER

public static final int ALLOWED_SANS_FIELD_NUMBER
Field Value
Type Description
int

MAXIMUM_LIFETIME_FIELD_NUMBER

public static final int MAXIMUM_LIFETIME_FIELD_NUMBER
Field Value
Type Description
int

OVERWRITE_CONFIG_VALUES_FIELD_NUMBER

public static final int OVERWRITE_CONFIG_VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CertificateAuthority.CertificateAuthorityPolicy getDefaultInstance()
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy

getDescriptor()

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

newBuilder()

public static CertificateAuthority.CertificateAuthorityPolicy.Builder newBuilder()
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy.Builder

newBuilder(CertificateAuthority.CertificateAuthorityPolicy prototype)

public static CertificateAuthority.CertificateAuthorityPolicy.Builder newBuilder(CertificateAuthority.CertificateAuthorityPolicy prototype)
Parameter
Name Description
prototype CertificateAuthority.CertificateAuthorityPolicy
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy.Builder

parseDelimitedFrom(InputStream input)

public static CertificateAuthority.CertificateAuthorityPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority.CertificateAuthorityPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CertificateAuthority.CertificateAuthorityPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Name Description
index int

The index of the element to return.
Returns
Type Description
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
Name Description
index int

The index of the value to return.
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
CertificateAuthority.CertificateAuthorityPolicy.AllowedSubjectAltNamesOrBuilder

getConfigPolicyCase()

public CertificateAuthority.CertificateAuthorityPolicy.ConfigPolicyCase getConfigPolicyCase()
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy.ConfigPolicyCase

getDefaultInstanceForType()

public CertificateAuthority.CertificateAuthorityPolicy getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ReusableConfigWrapperOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the overwriteConfigValues field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CertificateAuthority.CertificateAuthorityPolicy.Builder newBuilderForType()
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CertificateAuthority.CertificateAuthorityPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CertificateAuthority.CertificateAuthorityPolicy.Builder toBuilder()
Returns
Type Description
CertificateAuthority.CertificateAuthorityPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException