Class CaPool (2.46.0)

public final class CaPool extends GeneratedMessageV3 implements CaPoolOrBuilder

A CaPool represents a group of CertificateAuthorities that form a trust anchor. A CaPool can be used to manage issuance policies for one or more CertificateAuthority resources and to rotate CA certificates in and out of the trust anchor.

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

Implements

CaPoolOrBuilder

Static Fields

ISSUANCE_POLICY_FIELD_NUMBER

public static final int ISSUANCE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PUBLISHING_OPTIONS_FIELD_NUMBER

public static final int PUBLISHING_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

TIER_FIELD_NUMBER

public static final int TIER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CaPool getDefaultInstance()
Returns
Type Description
CaPool

getDescriptor()

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

newBuilder()

public static CaPool.Builder newBuilder()
Returns
Type Description
CaPool.Builder

newBuilder(CaPool prototype)

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

parseDelimitedFrom(InputStream input)

public static CaPool parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CaPool
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static CaPool parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CaPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static CaPool parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CaPool
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static CaPool parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CaPool
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static CaPool parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CaPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<CaPool> parser()
Returns
Type Description
Parser<CaPool>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CaPool getDefaultInstanceForType()
Returns
Type Description
CaPool

getIssuancePolicy()

public CaPool.IssuancePolicy getIssuancePolicy()

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CaPool.IssuancePolicy

The issuancePolicy.

getIssuancePolicyOrBuilder()

public CaPool.IssuancePolicyOrBuilder getIssuancePolicyOrBuilder()

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CaPool.IssuancePolicyOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels with user-defined metadata.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name for this CaPool in the format projects/*/locations/*/caPools/*.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<CaPool> getParserForType()
Returns
Type Description
Parser<CaPool>
Overrides

getPublishingOptions()

public CaPool.PublishingOptions getPublishingOptions()

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CaPool.PublishingOptions

The publishingOptions.

getPublishingOptionsOrBuilder()

public CaPool.PublishingOptionsOrBuilder getPublishingOptionsOrBuilder()

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CaPool.PublishingOptionsOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTier()

public CaPool.Tier getTier()

Required. Immutable. The Tier of this CaPool.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
CaPool.Tier

The tier.

getTierValue()

public int getTierValue()

Required. Immutable. The Tier of this CaPool.

.google.cloud.security.privateca.v1.CaPool.Tier tier = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for tier.

hasIssuancePolicy()

public boolean hasIssuancePolicy()

Optional. The IssuancePolicy to control how Certificates will be issued from this CaPool.

.google.cloud.security.privateca.v1.CaPool.IssuancePolicy issuance_policy = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the issuancePolicy field is set.

hasPublishingOptions()

public boolean hasPublishingOptions()

Optional. The PublishingOptions to follow when issuing Certificates from any CertificateAuthority in this CaPool.

.google.cloud.security.privateca.v1.CaPool.PublishingOptions publishing_options = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the publishingOptions field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CaPool.Builder newBuilderForType()
Returns
Type Description
CaPool.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public CaPool.Builder toBuilder()
Returns
Type Description
CaPool.Builder

writeTo(CodedOutputStream output)

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