Class protos.google.cloud.iap.v1.GcipSettings (1.0.1)

Represents a GcipSettings.

Package

@google-cloud/iap!

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 IGcipSettings 
 ); 
 

Constructs a new GcipSettings.

Parameter
Name Description
properties IGcipSettings

Properties to set

Properties

loginPageUri

  public 
  
 loginPageUri 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 IStringValue 
 | 
 null 
 ); 
 

GcipSettings loginPageUri.

Property Value
Type Description
( google.protobuf.IStringValue |null)

tenantIds

  public 
  
 tenantIds 
 : 
  
 string 
 []; 
 

GcipSettings tenantIds.

Property Value
Type Description
string[]

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 IGcipSettings 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 GcipSettings 
 ; 
 

Creates a new GcipSettings instance using the specified properties.

Parameter
Name Description
properties IGcipSettings

Properties to set

Returns
Type Description
google.cloud.iap.v1.GcipSettings

GcipSettings instance

decode(reader, length)

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

Decodes a GcipSettings 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.cloud.iap.v1.GcipSettings

GcipSettings

decodeDelimited(reader)

  public 
  
 static 
  
 decodeDelimited 
 ( 
 reader 
 : 
  
 ( 
 $protobuf 
 . 
 Reader 
 | 
 Uint8Array 
 )) 
 : 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 GcipSettings 
 ; 
 

Decodes a GcipSettings 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.cloud.iap.v1.GcipSettings

GcipSettings

encode(message, writer)

  public 
  
 static 
  
 encode 
 ( 
 message 
 : 
  
 google 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 IGcipSettings 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

Encodes the specified GcipSettings message. Does not implicitly messages.

Parameters
Name Description
message IGcipSettings

GcipSettings 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 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 IGcipSettings 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

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

Parameters
Name Description
message IGcipSettings

GcipSettings 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 
 . 
 cloud 
 . 
 iap 
 . 
 v1 
 . 
 GcipSettings 
 ; 
 

Creates a GcipSettings 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.cloud.iap.v1.GcipSettings

GcipSettings

toJSON()

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

Converts this GcipSettings to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.iap.v1.GcipSettings

GcipSettings

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

Design a Mobile Site
View Site in Mobile | Classic
Share by: