Class protos.google.iam.v1.SetIamPolicyRequest (6.3.1)

Represents a SetIamPolicyRequest.

Package

@google-cloud/security-center

Constructors

(constructor)(properties)

constructor(properties?: google.iam.v1.ISetIamPolicyRequest);

Constructs a new SetIamPolicyRequest.

Parameter
Name Description
properties ISetIamPolicyRequest

Properties to set

Properties

policy

public policy?: (google.iam.v1.IPolicy|null);

SetIamPolicyRequest policy.

resource

public resource: string;

SetIamPolicyRequest resource.

updateMask

public updateMask?: (google.protobuf.IFieldMask|null);

SetIamPolicyRequest updateMask.

Methods

create(properties)

public static create(properties?: google.iam.v1.ISetIamPolicyRequest): google.iam.v1.SetIamPolicyRequest;

Creates a new SetIamPolicyRequest instance using the specified properties.

Parameter
Name Description
properties ISetIamPolicyRequest

Properties to set
Returns
Type Description
google.iam.v1.SetIamPolicyRequest

SetIamPolicyRequest instance

decode(reader, length)

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

Decodes a SetIamPolicyRequest message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.iam.v1.SetIamPolicyRequest

SetIamPolicyRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.iam.v1.SetIamPolicyRequest

SetIamPolicyRequest

encode(message, writer)

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

Encodes the specified SetIamPolicyRequest message. Does not implicitly messages.

Parameters
Name Description
message ISetIamPolicyRequest

SetIamPolicyRequest 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.v1.ISetIamPolicyRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISetIamPolicyRequest

SetIamPolicyRequest 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.v1.SetIamPolicyRequest;

Creates a SetIamPolicyRequest 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
google.iam.v1.SetIamPolicyRequest

SetIamPolicyRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SetIamPolicyRequest

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 SetIamPolicyRequest to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.iam.v1.SetIamPolicyRequest

SetIamPolicyRequest
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 SetIamPolicyRequest 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