Class protos.google.cloud.dataplex.v1.Asset (3.2.0)

Represents an Asset.

Package

@google-cloud/dataplex

Constructors

(constructor)(properties)

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

Constructs a new Asset.

Parameter
NameDescription
properties IAsset

Properties to set

Properties

createTime

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

Asset createTime.

description

public description: string;

Asset description.

discoverySpec

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

Asset discoverySpec.

discoveryStatus

public discoveryStatus?: (google.cloud.dataplex.v1.Asset.IDiscoveryStatus|null);

Asset discoveryStatus.

displayName

public displayName: string;

Asset displayName.

labels

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

Asset labels.

name

public name: string;

Asset name.

resourceSpec

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

Asset resourceSpec.

resourceStatus

public resourceStatus?: (google.cloud.dataplex.v1.Asset.IResourceStatus|null);

Asset resourceStatus.

securityStatus

public securityStatus?: (google.cloud.dataplex.v1.Asset.ISecurityStatus|null);

Asset securityStatus.

state

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

Asset state.

uid

public uid: string;

Asset uid.

updateTime

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

Asset updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.dataplex.v1.IAsset): google.cloud.dataplex.v1.Asset;

Creates a new Asset instance using the specified properties.

Parameter
NameDescription
properties IAsset

Properties to set

Returns
TypeDescription
Asset

Asset instance

decode(reader, length)

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

Decodes an Asset message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Asset

Asset

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Asset

Asset

encode(message, writer)

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

Encodes the specified Asset message. Does not implicitly messages.

Parameters
NameDescription
message IAsset

Asset message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IAsset

Asset message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dataplex.v1.Asset;

Creates an Asset message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
Asset

Asset

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Asset

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Asset to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Asset

Asset

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Asset message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not