Class X509Parameters.CaOptions (2.46.0)

public static final class X509Parameters.CaOptions extends GeneratedMessageV3 implements X509Parameters.CaOptionsOrBuilder

Describes values that are relevant in a CA certificate.

Protobuf type google.cloud.security.privateca.v1.X509Parameters.CaOptions

Static Fields

IS_CA_FIELD_NUMBER

public static final int IS_CA_FIELD_NUMBER
Field Value
Type Description
int

MAX_ISSUER_PATH_LENGTH_FIELD_NUMBER

public static final int MAX_ISSUER_PATH_LENGTH_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static X509Parameters.CaOptions getDefaultInstance()
Returns
Type Description
X509Parameters.CaOptions

getDescriptor()

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

newBuilder()

public static X509Parameters.CaOptions.Builder newBuilder()
Returns
Type Description
X509Parameters.CaOptions.Builder

newBuilder(X509Parameters.CaOptions prototype)

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

parseDelimitedFrom(InputStream input)

public static X509Parameters.CaOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
X509Parameters.CaOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static X509Parameters.CaOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
X509Parameters.CaOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static X509Parameters.CaOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
X509Parameters.CaOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static X509Parameters.CaOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
X509Parameters.CaOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static X509Parameters.CaOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
X509Parameters.CaOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<X509Parameters.CaOptions> parser()
Returns
Type Description
Parser<CaOptions>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public X509Parameters.CaOptions getDefaultInstanceForType()
Returns
Type Description
X509Parameters.CaOptions

getIsCa()

public boolean getIsCa()

Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

optional bool is_ca = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The isCa.

getMaxIssuerPathLength()

public int getMaxIssuerPathLength()

Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

optional int32 max_issuer_path_length = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The maxIssuerPathLength.

getParserForType()

public Parser<X509Parameters.CaOptions> getParserForType()
Returns
Type Description
Parser<CaOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasIsCa()

public boolean hasIsCa()

Optional. Refers to the "CA" X.509 extension, which is a boolean value. When this value is missing, the extension will be omitted from the CA certificate.

optional bool is_ca = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the isCa field is set.

hasMaxIssuerPathLength()

public boolean hasMaxIssuerPathLength()

Optional. Refers to the path length restriction X.509 extension. For a CA certificate, this value describes the depth of subordinate CA certificates that are allowed. If this value is less than 0, the request will fail. If this value is missing, the max path length will be omitted from the CA certificate.

optional int32 max_issuer_path_length = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxIssuerPathLength 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 X509Parameters.CaOptions.Builder newBuilderForType()
Returns
Type Description
X509Parameters.CaOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public X509Parameters.CaOptions.Builder toBuilder()
Returns
Type Description
X509Parameters.CaOptions.Builder

writeTo(CodedOutputStream output)

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