Class protos.google.iam.v3.CreatePrincipalAccessBoundaryPolicyRequest (2.2.0)

Represents a CreatePrincipalAccessBoundaryPolicyRequest.

Package

@google-cloud/iam

Constructors

(constructor)(properties)

constructor(properties?: google.iam.v3.ICreatePrincipalAccessBoundaryPolicyRequest);

Constructs a new CreatePrincipalAccessBoundaryPolicyRequest.

Parameter
Name Description
properties ICreatePrincipalAccessBoundaryPolicyRequest

Properties to set

Properties

parent

public parent: string;

CreatePrincipalAccessBoundaryPolicyRequest parent.

principalAccessBoundaryPolicy

public principalAccessBoundaryPolicy?: (google.iam.v3.IPrincipalAccessBoundaryPolicy|null);

CreatePrincipalAccessBoundaryPolicyRequest principalAccessBoundaryPolicy.

principalAccessBoundaryPolicyId

public principalAccessBoundaryPolicyId: string;

CreatePrincipalAccessBoundaryPolicyRequest principalAccessBoundaryPolicyId.

validateOnly

public validateOnly: boolean;

CreatePrincipalAccessBoundaryPolicyRequest validateOnly.

Methods

create(properties)

public static create(properties?: google.iam.v3.ICreatePrincipalAccessBoundaryPolicyRequest): google.iam.v3.CreatePrincipalAccessBoundaryPolicyRequest;

Creates a new CreatePrincipalAccessBoundaryPolicyRequest instance using the specified properties.

Parameter
Name Description
properties ICreatePrincipalAccessBoundaryPolicyRequest

Properties to set

Returns
Type Description
CreatePrincipalAccessBoundaryPolicyRequest

CreatePrincipalAccessBoundaryPolicyRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.iam.v3.CreatePrincipalAccessBoundaryPolicyRequest;

Decodes a CreatePrincipalAccessBoundaryPolicyRequest message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
CreatePrincipalAccessBoundaryPolicyRequest

CreatePrincipalAccessBoundaryPolicyRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.v3.CreatePrincipalAccessBoundaryPolicyRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CreatePrincipalAccessBoundaryPolicyRequest

CreatePrincipalAccessBoundaryPolicyRequest

encode(message, writer)

public static encode(message: google.iam.v3.ICreatePrincipalAccessBoundaryPolicyRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CreatePrincipalAccessBoundaryPolicyRequest message. Does not implicitly messages.

Parameters
Name Description
message ICreatePrincipalAccessBoundaryPolicyRequest

CreatePrincipalAccessBoundaryPolicyRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.iam.v3.ICreatePrincipalAccessBoundaryPolicyRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICreatePrincipalAccessBoundaryPolicyRequest

CreatePrincipalAccessBoundaryPolicyRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.iam.v3.CreatePrincipalAccessBoundaryPolicyRequest;

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

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
CreatePrincipalAccessBoundaryPolicyRequest

CreatePrincipalAccessBoundaryPolicyRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CreatePrincipalAccessBoundaryPolicyRequest

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

toJSON()

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

Converts this CreatePrincipalAccessBoundaryPolicyRequest to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.iam.v3.CreatePrincipalAccessBoundaryPolicyRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message CreatePrincipalAccessBoundaryPolicyRequest

CreatePrincipalAccessBoundaryPolicyRequest

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a CreatePrincipalAccessBoundaryPolicyRequest message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not