Class protos.google.iam.v2.GetPolicyRequest (2.2.0)
Represents a GetPolicyRequest.
Package
@google-cloud/iamConstructors
(constructor)(properties)
constructor(properties?:google.iam.v2.IGetPolicyRequest);Constructs a new GetPolicyRequest.
| Parameter | |
|---|---|
| Name | Description |
properties | IGetPolicyRequestProperties to set |
Properties
name
publicname:string;GetPolicyRequest name.
Methods
create(properties)
publicstaticcreate(properties?:google.iam.v2.IGetPolicyRequest):google.iam.v2.GetPolicyRequest;Creates a new GetPolicyRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IGetPolicyRequestProperties to set |
| Returns | |
|---|---|
| Type | Description |
GetPolicyRequest | GetPolicyRequest instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.iam.v2.GetPolicyRequest;Decodes a GetPolicyRequest message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
GetPolicyRequest | GetPolicyRequest |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.iam.v2.GetPolicyRequest;Decodes a GetPolicyRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
GetPolicyRequest | GetPolicyRequest |
encode(message, writer)
publicstaticencode(message:google.iam.v2.IGetPolicyRequest,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified GetPolicyRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IGetPolicyRequestGetPolicyRequest message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.iam.v2.IGetPolicyRequest,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified GetPolicyRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IGetPolicyRequestGetPolicyRequest message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.iam.v2.GetPolicyRequest;Creates a GetPolicyRequest 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 |
GetPolicyRequest | GetPolicyRequest |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for GetPolicyRequest
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this GetPolicyRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.iam.v2.GetPolicyRequest,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a GetPolicyRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | GetPolicyRequestGetPolicyRequest |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a GetPolicyRequest message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.