Class protos.google.cloud.managedidentities.v1beta1.Domain (1.0.7)

Represents a Domain.

Package

@google-cloud/managed-identities!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.managedidentities.v1beta1.IDomain);

Constructs a new Domain.

Parameter

Name	Description
properties	`IDomain` Properties to set

Properties

admin

public admin: string;

Domain admin.

Property Value

Type	Description
string

authorizedNetworks

public authorizedNetworks: string[];

Domain authorizedNetworks.

Property Value

Type	Description
string[]

createTime

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

Domain createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

fqdn

public fqdn: string;

Domain fqdn.

Property Value

Type	Description
string

labels

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

Domain labels.

Property Value

Type	Description
{ [k: string]: string }

locations

public locations: string[];

Domain locations.

Property Value

Type	Description
string[]

name

public name: string;

Domain name.

Property Value

Type	Description
string

reservedIpRange

public reservedIpRange: string;

Domain reservedIpRange.

Property Value

Type	Description
string

state

public state: (google.cloud.managedidentities.v1beta1.Domain.State|keyof typeof google.cloud.managedidentities.v1beta1.Domain.State);

Domain state.

Property Value

Type	Description
(google.cloud.managedidentities.v1beta1.Domain.State\|keyof typeof google.cloud.managedidentities.v1beta1.Domain.State)

statusMessage

public statusMessage: string;

Domain statusMessage.

Property Value

Type	Description
string

trusts

public trusts: google.cloud.managedidentities.v1beta1.ITrust[];

Domain trusts.

Property Value

Type	Description
google.cloud.managedidentities.v1beta1.ITrust[]

updateTime

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

Domain updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

Methods

create(properties)

public static create(properties?: google.cloud.managedidentities.v1beta1.IDomain): google.cloud.managedidentities.v1beta1.Domain;

Creates a new Domain instance using the specified properties.

Parameter

Name	Description
properties	`IDomain` Properties to set

Returns

Type	Description
google.cloud.managedidentities.v1beta1.Domain	Domain instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.managedidentities.v1beta1.Domain;

Decodes a Domain 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.managedidentities.v1beta1.Domain	Domain

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.managedidentities.v1beta1.Domain;

Decodes a Domain 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.managedidentities.v1beta1.Domain	Domain

encode(message, writer)

public static encode(message: google.cloud.managedidentities.v1beta1.IDomain, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Domain message. Does not implicitly messages.

Parameters

Name	Description
message	`IDomain` Domain 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.managedidentities.v1beta1.IDomain, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IDomain` Domain 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.managedidentities.v1beta1.Domain;

Creates a Domain 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.managedidentities.v1beta1.Domain	Domain

toJSON()

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

Converts this Domain to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.managedidentities.v1beta1.Domain` Domain
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 Domain 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