Class protos.google.cloud.accessapproval.v1.AccessApprovalSettings (3.2.0)

Represents an AccessApprovalSettings.

Package

@google-cloud/access-approval

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.accessapproval.v1.IAccessApprovalSettings);

Constructs a new AccessApprovalSettings.

Parameter
NameDescription
properties IAccessApprovalSettings

Properties to set

Properties

activeKeyVersion

public activeKeyVersion: string;

AccessApprovalSettings activeKeyVersion.

ancestorHasActiveKeyVersion

public ancestorHasActiveKeyVersion: boolean;

AccessApprovalSettings ancestorHasActiveKeyVersion.

enrolledAncestor

public enrolledAncestor: boolean;

AccessApprovalSettings enrolledAncestor.

enrolledServices

public enrolledServices: google.cloud.accessapproval.v1.IEnrolledService[];

AccessApprovalSettings enrolledServices.

invalidKeyVersion

public invalidKeyVersion: boolean;

AccessApprovalSettings invalidKeyVersion.

name

public name: string;

AccessApprovalSettings name.

notificationEmails

public notificationEmails: string[];

AccessApprovalSettings notificationEmails.

Methods

create(properties)

public static create(properties?: google.cloud.accessapproval.v1.IAccessApprovalSettings): google.cloud.accessapproval.v1.AccessApprovalSettings;

Creates a new AccessApprovalSettings instance using the specified properties.

Parameter
NameDescription
properties IAccessApprovalSettings

Properties to set

Returns
TypeDescription
AccessApprovalSettings

AccessApprovalSettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.accessapproval.v1.AccessApprovalSettings;

Decodes an AccessApprovalSettings message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
AccessApprovalSettings

AccessApprovalSettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.accessapproval.v1.AccessApprovalSettings;

Decodes an AccessApprovalSettings message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
AccessApprovalSettings

AccessApprovalSettings

encode(message, writer)

public static encode(message: google.cloud.accessapproval.v1.IAccessApprovalSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AccessApprovalSettings message. Does not implicitly messages.

Parameters
NameDescription
message IAccessApprovalSettings

AccessApprovalSettings 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.accessapproval.v1.IAccessApprovalSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAccessApprovalSettings

AccessApprovalSettings 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.accessapproval.v1.AccessApprovalSettings;

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

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

Plain object

Returns
TypeDescription
AccessApprovalSettings

AccessApprovalSettings

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for AccessApprovalSettings

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this AccessApprovalSettings to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.accessapproval.v1.AccessApprovalSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message AccessApprovalSettings

AccessApprovalSettings

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AccessApprovalSettings 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