Class protos.google.iam.v1.Policy (5.5.2)
Represents a Policy.
Package
@google-cloud/tasksConstructors
(constructor)(properties)
constructor(properties?:google.iam.v1.IPolicy);Constructs a new Policy.
| Parameter | |
|---|---|
| Name | Description |
properties | IPolicyProperties to set |
Properties
auditConfigs
publicauditConfigs:google.iam.v1.IAuditConfig[];Policy auditConfigs.
bindings
publicbindings:google.iam.v1.IBinding[];Policy bindings.
etag
publicetag:(Uint8Array|string);Policy etag.
version
publicversion:number;Policy version.
Methods
create(properties)
publicstaticcreate(properties?:google.iam.v1.IPolicy):google.iam.v1.Policy;Creates a new Policy instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IPolicyProperties to set |
| Returns | |
|---|---|
| Type | Description |
Policy | Policy instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.iam.v1.Policy;Decodes a Policy 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 |
Policy | Policy |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.iam.v1.Policy;Decodes a Policy message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Policy | Policy |
encode(message, writer)
publicstaticencode(message:google.iam.v1.IPolicy,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Policy message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IPolicyPolicy 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.v1.IPolicy,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Policy message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IPolicyPolicy 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.v1.Policy;Creates a Policy 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 |
Policy | Policy |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for Policy
| 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 Policy to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.iam.v1.Policy,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a Policy message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | PolicyPolicy |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a Policy 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.