Class protos.google.cloud.iap.v1.IapSettings (2.0.3)

Represents an IapSettings.

Package

Constructors

(constructor)(properties)

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

Constructs a new IapSettings.

Parameter

Name	Description
properties	`IIapSettings` Properties to set

Properties

accessSettings

public accessSettings?: (google.cloud.iap.v1.IAccessSettings|null);

IapSettings accessSettings.

applicationSettings

public applicationSettings?: (google.cloud.iap.v1.IApplicationSettings|null);

IapSettings applicationSettings.

name

public name: string;

IapSettings name.

Methods

create(properties)

public static create(properties?: google.cloud.iap.v1.IIapSettings): google.cloud.iap.v1.IapSettings;

Creates a new IapSettings instance using the specified properties.

Parameter

Name	Description
properties	`IIapSettings` Properties to set

Returns

Type	Description
google.cloud.iap.v1.IapSettings	IapSettings instance

decode(reader, length)

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

Decodes an IapSettings 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.IapSettings	IapSettings

decodeDelimited(reader)

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

Decodes an IapSettings 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.IapSettings	IapSettings

encode(message, writer)

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

Encodes the specified IapSettings message. Does not implicitly messages.

Parameters

Name	Description
message	`IIapSettings` IapSettings 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.IIapSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IIapSettings` IapSettings 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.IapSettings;

Creates an IapSettings 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.IapSettings	IapSettings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for IapSettings

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

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.iap.v1.IapSettings` IapSettings
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 an IapSettings 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