Class protos.google.cloud.networksecurity.v1alpha1.PartnerSSERealm (3.6.0)

Represents a PartnerSSERealm.

Implements

Package

@google-cloud/network-security

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networksecurity.v1alpha1.IPartnerSSERealm);

Constructs a new PartnerSSERealm.

Parameter
Name Description
properties IPartnerSSERealm

Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

PartnerSSERealm createTime.

labels

public labels: { [k: string]: string };

PartnerSSERealm labels.

name

public name: string;

PartnerSSERealm name.

pairingKey

public pairingKey: string;

PartnerSSERealm pairingKey.

panOptions

public panOptions?: (google.cloud.networksecurity.v1alpha1.PartnerSSERealm.IPartnerSSERealmPanOptions|null);

PartnerSSERealm panOptions.

partnerNetwork

public partnerNetwork: string;

PartnerSSERealm partnerNetwork.

partnerVpc

public partnerVpc: string;

PartnerSSERealm partnerVpc.

sseNetwork

public sseNetwork: string;

PartnerSSERealm sseNetwork.

sseProject

public sseProject: string;

PartnerSSERealm sseProject.

sseProjectNumber

public sseProjectNumber: (number|Long|string);

PartnerSSERealm sseProjectNumber.

sseVpc

public sseVpc: string;

PartnerSSERealm sseVpc.

state

public state: (google.cloud.networksecurity.v1alpha1.PartnerSSERealm.State|keyof typeof google.cloud.networksecurity.v1alpha1.PartnerSSERealm.State);

PartnerSSERealm state.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

PartnerSSERealm updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.networksecurity.v1alpha1.IPartnerSSERealm): google.cloud.networksecurity.v1alpha1.PartnerSSERealm;

Creates a new PartnerSSERealm instance using the specified properties.

Parameter
Name Description
properties IPartnerSSERealm

Properties to set

Returns
Type Description
PartnerSSERealm

PartnerSSERealm instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networksecurity.v1alpha1.PartnerSSERealm;

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

PartnerSSERealm

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networksecurity.v1alpha1.PartnerSSERealm;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PartnerSSERealm

PartnerSSERealm

encode(message, writer)

public static encode(message: google.cloud.networksecurity.v1alpha1.IPartnerSSERealm, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PartnerSSERealm message. Does not implicitly messages.

Parameters
Name Description
message IPartnerSSERealm

PartnerSSERealm 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.networksecurity.v1alpha1.IPartnerSSERealm, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPartnerSSERealm

PartnerSSERealm 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.networksecurity.v1alpha1.PartnerSSERealm;

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

PartnerSSERealm

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PartnerSSERealm

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message PartnerSSERealm

PartnerSSERealm

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