Class protos.google.iam.v2.DenyRule (2.2.0)

Represents a DenyRule.

Package

@google-cloud/iam

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 iam 
 . 
 v2 
 . 
 IDenyRule 
 ); 
 

Constructs a new DenyRule.

Parameter
Name
Description
properties
IDenyRule

Properties to set

Properties

denialCondition

  public 
  
 denialCondition 
 ?: 
  
 ( 
 google 
 . 
 type 
 . 
 IExpr 
 | 
 null 
 ); 
 

DenyRule denialCondition.

deniedPermissions

  public 
  
 deniedPermissions 
 : 
  
 string 
 []; 
 

DenyRule deniedPermissions.

deniedPrincipals

  public 
  
 deniedPrincipals 
 : 
  
 string 
 []; 
 

DenyRule deniedPrincipals.

exceptionPermissions

  public 
  
 exceptionPermissions 
 : 
  
 string 
 []; 
 

DenyRule exceptionPermissions.

exceptionPrincipals

  public 
  
 exceptionPrincipals 
 : 
  
 string 
 []; 
 

DenyRule exceptionPrincipals.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 iam 
 . 
 v2 
 . 
 IDenyRule 
 ) 
 : 
  
 google 
 . 
 iam 
 . 
 v2 
 . 
 DenyRule 
 ; 
 

Creates a new DenyRule instance using the specified properties.

Parameter
Name
Description
properties
IDenyRule

Properties to set

Returns
Type
Description

DenyRule instance

decode(reader, length)

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

Decodes a DenyRule 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

DenyRule

decodeDelimited(reader)

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

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

Parameter
Name
Description
reader
( Reader | Uint8Array )

Reader or buffer to decode from

Returns
Type
Description

DenyRule

encode(message, writer)

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

Encodes the specified DenyRule message. Does not implicitly messages.

Parameters
Name
Description
message
IDenyRule

DenyRule 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 
 . 
 v2 
 . 
 IDenyRule 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

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

Parameters
Name
Description
message
IDenyRule

DenyRule 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 
 . 
 v2 
 . 
 DenyRule 
 ; 
 

Creates a DenyRule 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

DenyRule

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DenyRule

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name
Description
message
DenyRule

DenyRule

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

Create a Mobile Website
View Site in Mobile | Classic
Share by: