Class protos.google.cloud.dataplex.v1.Zone (1.1.0)

Represents a Zone.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataplex.v1.IZone);

Constructs a new Zone.

Parameter

Name	Description
properties	`IZone` Properties to set

Properties

assetStatus

public assetStatus?: (google.cloud.dataplex.v1.IAssetStatus|null);

Zone assetStatus.

createTime

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

Zone createTime.

description

public description: string;

Zone description.

discoverySpec

public discoverySpec?: (google.cloud.dataplex.v1.Zone.IDiscoverySpec|null);

Zone discoverySpec.

displayName

public displayName: string;

Zone displayName.

labels

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

Zone labels.

name

public name: string;

Zone name.

resourceSpec

public resourceSpec?: (google.cloud.dataplex.v1.Zone.IResourceSpec|null);

Zone resourceSpec.

state

public state: (google.cloud.dataplex.v1.State|keyof typeof google.cloud.dataplex.v1.State);

Zone state.

type

public type: (google.cloud.dataplex.v1.Zone.Type|keyof typeof google.cloud.dataplex.v1.Zone.Type);

Zone type.

uid

public uid: string;

Zone uid.

updateTime

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

Zone updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.IZone): google.cloud.dataplex.v1.Zone;

Creates a new Zone instance using the specified properties.

Parameter

Name	Description
properties	`IZone` Properties to set

Returns

Type	Description
google.cloud.dataplex.v1.Zone	Zone instance

decode(reader, length)

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

Decodes a Zone 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.dataplex.v1.Zone	Zone

decodeDelimited(reader)

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

Decodes a Zone 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.dataplex.v1.Zone	Zone

encode(message, writer)

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

Encodes the specified Zone message. Does not implicitly messages.

Parameters

Name	Description
message	`IZone` Zone 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.dataplex.v1.IZone, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IZone` Zone 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.dataplex.v1.Zone;

Creates a Zone 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.dataplex.v1.Zone	Zone

toJSON()

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

Converts this Zone to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.dataplex.v1.Zone` Zone
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 Zone 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