Class protos.google.cloud.dataplex.v1.EntryGroup (3.11.0)

Represents an EntryGroup.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

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

Constructs a new EntryGroup.

Parameter
Name Description
properties IEntryGroup

Properties to set

Properties

createTime

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

EntryGroup createTime.

description

public description: string;

EntryGroup description.

displayName

public displayName: string;

EntryGroup displayName.

etag

public etag: string;

EntryGroup etag.

labels

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

EntryGroup labels.

name

public name: string;

EntryGroup name.

transferStatus

public transferStatus: (google.cloud.dataplex.v1.TransferStatus|keyof typeof google.cloud.dataplex.v1.TransferStatus);

EntryGroup transferStatus.

uid

public uid: string;

EntryGroup uid.

updateTime

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

EntryGroup updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.IEntryGroup): google.cloud.dataplex.v1.EntryGroup;

Creates a new EntryGroup instance using the specified properties.

Parameter
Name Description
properties IEntryGroup

Properties to set

Returns
Type Description
EntryGroup

EntryGroup instance

decode(reader, length)

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

Decodes an EntryGroup 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
EntryGroup

EntryGroup

decodeDelimited(reader)

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

Decodes an EntryGroup message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
EntryGroup

EntryGroup

encode(message, writer)

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

Encodes the specified EntryGroup message. Does not implicitly messages.

Parameters
Name Description
message IEntryGroup

EntryGroup 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.IEntryGroup, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IEntryGroup

EntryGroup 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.EntryGroup;

Creates an EntryGroup 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
EntryGroup

EntryGroup

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EntryGroup

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message EntryGroup

EntryGroup

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