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

Represents a MetadataService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.dataplex.v1.MetadataService

Package

@google-cloud/dataplex

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new MetadataService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): MetadataService;

Creates new MetadataService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
Type Description
MetadataService

RPC service. Useful where requests and/or responses are streamed.

createEntity(request, callback)

public createEntity(request: google.cloud.dataplex.v1.ICreateEntityRequest, callback: google.cloud.dataplex.v1.MetadataService.CreateEntityCallback): void;

Calls CreateEntity.

Parameters
Name Description
request ICreateEntityRequest

CreateEntityRequest message or plain object

callback CreateEntityCallback

Node-style callback called with the error, if any, and Entity

Returns
Type Description
void

createEntity(request)

public createEntity(request: google.cloud.dataplex.v1.ICreateEntityRequest): Promise<google.cloud.dataplex.v1.Entity>;

Calls CreateEntity.

Parameter
Name Description
request ICreateEntityRequest

CreateEntityRequest message or plain object

Returns
Type Description
Promise<google.cloud.dataplex.v1.Entity>

Promise

createPartition(request, callback)

public createPartition(request: google.cloud.dataplex.v1.ICreatePartitionRequest, callback: google.cloud.dataplex.v1.MetadataService.CreatePartitionCallback): void;

Calls CreatePartition.

Parameters
Name Description
request ICreatePartitionRequest

CreatePartitionRequest message or plain object

callback CreatePartitionCallback

Node-style callback called with the error, if any, and Partition

Returns
Type Description
void

createPartition(request)

public createPartition(request: google.cloud.dataplex.v1.ICreatePartitionRequest): Promise<google.cloud.dataplex.v1.Partition>;

Calls CreatePartition.

Parameter
Name Description
request ICreatePartitionRequest

CreatePartitionRequest message or plain object

Returns
Type Description
Promise<google.cloud.dataplex.v1.Partition>

Promise

deleteEntity(request, callback)

public deleteEntity(request: google.cloud.dataplex.v1.IDeleteEntityRequest, callback: google.cloud.dataplex.v1.MetadataService.DeleteEntityCallback): void;

Calls DeleteEntity.

Parameters
Name Description
request IDeleteEntityRequest

DeleteEntityRequest message or plain object

callback DeleteEntityCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteEntity(request)

public deleteEntity(request: google.cloud.dataplex.v1.IDeleteEntityRequest): Promise<google.protobuf.Empty>;

Calls DeleteEntity.

Parameter
Name Description
request IDeleteEntityRequest

DeleteEntityRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deletePartition(request, callback)

public deletePartition(request: google.cloud.dataplex.v1.IDeletePartitionRequest, callback: google.cloud.dataplex.v1.MetadataService.DeletePartitionCallback): void;

Calls DeletePartition.

Parameters
Name Description
request IDeletePartitionRequest

DeletePartitionRequest message or plain object

callback DeletePartitionCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deletePartition(request)

public deletePartition(request: google.cloud.dataplex.v1.IDeletePartitionRequest): Promise<google.protobuf.Empty>;

Calls DeletePartition.

Parameter
Name Description
request IDeletePartitionRequest

DeletePartitionRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

getEntity(request, callback)

public getEntity(request: google.cloud.dataplex.v1.IGetEntityRequest, callback: google.cloud.dataplex.v1.MetadataService.GetEntityCallback): void;

Calls GetEntity.

Parameters
Name Description
request IGetEntityRequest

GetEntityRequest message or plain object

callback GetEntityCallback

Node-style callback called with the error, if any, and Entity

Returns
Type Description
void

getEntity(request)

public getEntity(request: google.cloud.dataplex.v1.IGetEntityRequest): Promise<google.cloud.dataplex.v1.Entity>;

Calls GetEntity.

Parameter
Name Description
request IGetEntityRequest

GetEntityRequest message or plain object

Returns
Type Description
Promise<google.cloud.dataplex.v1.Entity>

Promise

getPartition(request, callback)

public getPartition(request: google.cloud.dataplex.v1.IGetPartitionRequest, callback: google.cloud.dataplex.v1.MetadataService.GetPartitionCallback): void;

Calls GetPartition.

Parameters
Name Description
request IGetPartitionRequest

GetPartitionRequest message or plain object

callback GetPartitionCallback

Node-style callback called with the error, if any, and Partition

Returns
Type Description
void

getPartition(request)

public getPartition(request: google.cloud.dataplex.v1.IGetPartitionRequest): Promise<google.cloud.dataplex.v1.Partition>;

Calls GetPartition.

Parameter
Name Description
request IGetPartitionRequest

GetPartitionRequest message or plain object

Returns
Type Description
Promise<google.cloud.dataplex.v1.Partition>

Promise

listEntities(request, callback)

public listEntities(request: google.cloud.dataplex.v1.IListEntitiesRequest, callback: google.cloud.dataplex.v1.MetadataService.ListEntitiesCallback): void;

Calls ListEntities.

Parameters
Name Description
request IListEntitiesRequest

ListEntitiesRequest message or plain object

callback ListEntitiesCallback

Node-style callback called with the error, if any, and ListEntitiesResponse

Returns
Type Description
void

listEntities(request)

public listEntities(request: google.cloud.dataplex.v1.IListEntitiesRequest): Promise<google.cloud.dataplex.v1.ListEntitiesResponse>;

Calls ListEntities.

Parameter
Name Description
request IListEntitiesRequest

ListEntitiesRequest message or plain object

Returns
Type Description
Promise<google.cloud.dataplex.v1.ListEntitiesResponse>

Promise

listPartitions(request, callback)

public listPartitions(request: google.cloud.dataplex.v1.IListPartitionsRequest, callback: google.cloud.dataplex.v1.MetadataService.ListPartitionsCallback): void;

Calls ListPartitions.

Parameters
Name Description
request IListPartitionsRequest

ListPartitionsRequest message or plain object

callback ListPartitionsCallback

Node-style callback called with the error, if any, and ListPartitionsResponse

Returns
Type Description
void

listPartitions(request)

public listPartitions(request: google.cloud.dataplex.v1.IListPartitionsRequest): Promise<google.cloud.dataplex.v1.ListPartitionsResponse>;

Calls ListPartitions.

Parameter
Name Description
request IListPartitionsRequest

ListPartitionsRequest message or plain object

Returns
Type Description
Promise<google.cloud.dataplex.v1.ListPartitionsResponse>

Promise

updateEntity(request, callback)

public updateEntity(request: google.cloud.dataplex.v1.IUpdateEntityRequest, callback: google.cloud.dataplex.v1.MetadataService.UpdateEntityCallback): void;

Calls UpdateEntity.

Parameters
Name Description
request IUpdateEntityRequest

UpdateEntityRequest message or plain object

callback UpdateEntityCallback

Node-style callback called with the error, if any, and Entity

Returns
Type Description
void

updateEntity(request)

public updateEntity(request: google.cloud.dataplex.v1.IUpdateEntityRequest): Promise<google.cloud.dataplex.v1.Entity>;

Calls UpdateEntity.

Parameter
Name Description
request IUpdateEntityRequest

UpdateEntityRequest message or plain object

Returns
Type Description
Promise<google.cloud.dataplex.v1.Entity>

Promise