Class protos.google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy

Represents a CertificateAuthorityPolicy.

Package

@google-cloud/security-private-ca

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.security.privateca.v1beta1.CertificateAuthority.ICertificateAuthorityPolicy);

Constructs a new CertificateAuthorityPolicy.

Parameter
NameDescription
properties ICertificateAuthorityPolicy

Properties to set

Properties

allowedCommonNames

public allowedCommonNames: string[];

CertificateAuthorityPolicy allowedCommonNames.

allowedConfigList

public allowedConfigList?: (google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IAllowedConfigList|null);

CertificateAuthorityPolicy allowedConfigList.

allowedIssuanceModes

public allowedIssuanceModes?: (google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IIssuanceModes|null);

CertificateAuthorityPolicy allowedIssuanceModes.

allowedLocationsAndOrganizations

public allowedLocationsAndOrganizations: google.cloud.security.privateca.v1beta1.ISubject[];

CertificateAuthorityPolicy allowedLocationsAndOrganizations.

allowedSans

public allowedSans?: (google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy.IAllowedSubjectAltNames|null);

CertificateAuthorityPolicy allowedSans.

configPolicy

public configPolicy?: ("allowedConfigList"|"overwriteConfigValues");

CertificateAuthorityPolicy configPolicy.

maximumLifetime

public maximumLifetime?: (google.protobuf.IDuration|null);

CertificateAuthorityPolicy maximumLifetime.

overwriteConfigValues

public overwriteConfigValues?: (google.cloud.security.privateca.v1beta1.IReusableConfigWrapper|null);

CertificateAuthorityPolicy overwriteConfigValues.

Methods

create(properties)

public static create(properties?: google.cloud.security.privateca.v1beta1.CertificateAuthority.ICertificateAuthorityPolicy): google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy;

Creates a new CertificateAuthorityPolicy instance using the specified properties.

Parameter
NameDescription
properties ICertificateAuthorityPolicy

Properties to set

Returns
TypeDescription
google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy

CertificateAuthorityPolicy instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy;

Decodes a CertificateAuthorityPolicy message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy

CertificateAuthorityPolicy

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy;

Decodes a CertificateAuthorityPolicy message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy

CertificateAuthorityPolicy

encode(message, writer)

public static encode(message: google.cloud.security.privateca.v1beta1.CertificateAuthority.ICertificateAuthorityPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CertificateAuthorityPolicy message. Does not implicitly messages.

Parameters
NameDescription
message ICertificateAuthorityPolicy

CertificateAuthorityPolicy message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.security.privateca.v1beta1.CertificateAuthority.ICertificateAuthorityPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CertificateAuthorityPolicy message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message ICertificateAuthorityPolicy

CertificateAuthorityPolicy message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy;

Creates a CertificateAuthorityPolicy message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy

CertificateAuthorityPolicy

toJSON()

public toJSON(): { [k: string]: any };

Converts this CertificateAuthorityPolicy to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a CertificateAuthorityPolicy message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.security.privateca.v1beta1.CertificateAuthority.CertificateAuthorityPolicy

CertificateAuthorityPolicy

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a CertificateAuthorityPolicy message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not