Class protos.google.cloud.dataplex.v1.CatalogService (3.7.0)

Version 3.7.0

• 3.13.0 (latest)
• 3.12.0
• 3.11.0
• 3.10.0
• 3.8.0
• 3.7.0
• 3.5.1
• 3.2.0
• 3.1.0
• 2.4.0
• 2.3.2
• 2.2.2
• 2.1.1
• 1.2.0
• 1.1.0
• 1.0.0

Represents a CatalogService

Inheritance

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

Package

@google-cloud/dataplex

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new CatalogService 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): CatalogService;

Creates new CatalogService 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
CatalogService	RPC service. Useful where requests and/or responses are streamed.

createAspectType(request, callback)

public createAspectType(request: google.cloud.dataplex.v1.ICreateAspectTypeRequest, callback: google.cloud.dataplex.v1.CatalogService.CreateAspectTypeCallback): void;

Calls CreateAspectType.

Parameters
Name	Description
request	ICreateAspectTypeRequest CreateAspectTypeRequest message or plain object
callback	CreateAspectTypeCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createAspectType(request)

public createAspectType(request: google.cloud.dataplex.v1.ICreateAspectTypeRequest): Promise<google.longrunning.Operation>;

Calls CreateAspectType.

Parameter
Name	Description
request	ICreateAspectTypeRequest CreateAspectTypeRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createEntry(request, callback)

public createEntry(request: google.cloud.dataplex.v1.ICreateEntryRequest, callback: google.cloud.dataplex.v1.CatalogService.CreateEntryCallback): void;

Calls CreateEntry.

Parameters
Name	Description
request	ICreateEntryRequest CreateEntryRequest message or plain object
callback	CreateEntryCallback Node-style callback called with the error, if any, and Entry

Returns
Type	Description
void

createEntry(request)

public createEntry(request: google.cloud.dataplex.v1.ICreateEntryRequest): Promise<google.cloud.dataplex.v1.Entry>;

Calls CreateEntry.

Parameter
Name	Description
request	ICreateEntryRequest CreateEntryRequest message or plain object

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

createEntryGroup(request, callback)

public createEntryGroup(request: google.cloud.dataplex.v1.ICreateEntryGroupRequest, callback: google.cloud.dataplex.v1.CatalogService.CreateEntryGroupCallback): void;

Calls CreateEntryGroup.

Parameters
Name	Description
request	ICreateEntryGroupRequest CreateEntryGroupRequest message or plain object
callback	CreateEntryGroupCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createEntryGroup(request)

public createEntryGroup(request: google.cloud.dataplex.v1.ICreateEntryGroupRequest): Promise<google.longrunning.Operation>;

Calls CreateEntryGroup.

Parameter
Name	Description
request	ICreateEntryGroupRequest CreateEntryGroupRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createEntryType(request, callback)

public createEntryType(request: google.cloud.dataplex.v1.ICreateEntryTypeRequest, callback: google.cloud.dataplex.v1.CatalogService.CreateEntryTypeCallback): void;

Calls CreateEntryType.

Parameters
Name	Description
request	ICreateEntryTypeRequest CreateEntryTypeRequest message or plain object
callback	CreateEntryTypeCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createEntryType(request)

public createEntryType(request: google.cloud.dataplex.v1.ICreateEntryTypeRequest): Promise<google.longrunning.Operation>;

Calls CreateEntryType.

Parameter
Name	Description
request	ICreateEntryTypeRequest CreateEntryTypeRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteAspectType(request, callback)

public deleteAspectType(request: google.cloud.dataplex.v1.IDeleteAspectTypeRequest, callback: google.cloud.dataplex.v1.CatalogService.DeleteAspectTypeCallback): void;

Calls DeleteAspectType.

Parameters
Name	Description
request	IDeleteAspectTypeRequest DeleteAspectTypeRequest message or plain object
callback	DeleteAspectTypeCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteAspectType(request)

public deleteAspectType(request: google.cloud.dataplex.v1.IDeleteAspectTypeRequest): Promise<google.longrunning.Operation>;

Calls DeleteAspectType.

Parameter
Name	Description
request	IDeleteAspectTypeRequest DeleteAspectTypeRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteEntry(request, callback)

public deleteEntry(request: google.cloud.dataplex.v1.IDeleteEntryRequest, callback: google.cloud.dataplex.v1.CatalogService.DeleteEntryCallback): void;

Calls DeleteEntry.

Parameters
Name	Description
request	IDeleteEntryRequest DeleteEntryRequest message or plain object
callback	DeleteEntryCallback Node-style callback called with the error, if any, and Entry

Returns
Type	Description
void

deleteEntry(request)

public deleteEntry(request: google.cloud.dataplex.v1.IDeleteEntryRequest): Promise<google.cloud.dataplex.v1.Entry>;

Calls DeleteEntry.

Parameter
Name	Description
request	IDeleteEntryRequest DeleteEntryRequest message or plain object

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

deleteEntryGroup(request, callback)

public deleteEntryGroup(request: google.cloud.dataplex.v1.IDeleteEntryGroupRequest, callback: google.cloud.dataplex.v1.CatalogService.DeleteEntryGroupCallback): void;

Calls DeleteEntryGroup.

Parameters
Name	Description
request	IDeleteEntryGroupRequest DeleteEntryGroupRequest message or plain object
callback	DeleteEntryGroupCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteEntryGroup(request)

public deleteEntryGroup(request: google.cloud.dataplex.v1.IDeleteEntryGroupRequest): Promise<google.longrunning.Operation>;

Calls DeleteEntryGroup.

Parameter
Name	Description
request	IDeleteEntryGroupRequest DeleteEntryGroupRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteEntryType(request, callback)

public deleteEntryType(request: google.cloud.dataplex.v1.IDeleteEntryTypeRequest, callback: google.cloud.dataplex.v1.CatalogService.DeleteEntryTypeCallback): void;

Calls DeleteEntryType.

Parameters
Name	Description
request	IDeleteEntryTypeRequest DeleteEntryTypeRequest message or plain object
callback	DeleteEntryTypeCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteEntryType(request)

public deleteEntryType(request: google.cloud.dataplex.v1.IDeleteEntryTypeRequest): Promise<google.longrunning.Operation>;

Calls DeleteEntryType.

Parameter
Name	Description
request	IDeleteEntryTypeRequest DeleteEntryTypeRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

getAspectType(request, callback)

public getAspectType(request: google.cloud.dataplex.v1.IGetAspectTypeRequest, callback: google.cloud.dataplex.v1.CatalogService.GetAspectTypeCallback): void;

Calls GetAspectType.

Parameters
Name	Description
request	IGetAspectTypeRequest GetAspectTypeRequest message or plain object
callback	GetAspectTypeCallback Node-style callback called with the error, if any, and AspectType

Returns
Type	Description
void

getAspectType(request)

public getAspectType(request: google.cloud.dataplex.v1.IGetAspectTypeRequest): Promise<google.cloud.dataplex.v1.AspectType>;

Calls GetAspectType.

Parameter
Name	Description
request	IGetAspectTypeRequest GetAspectTypeRequest message or plain object

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

getEntry(request, callback)

public getEntry(request: google.cloud.dataplex.v1.IGetEntryRequest, callback: google.cloud.dataplex.v1.CatalogService.GetEntryCallback): void;

Calls GetEntry.

Parameters
Name	Description
request	IGetEntryRequest GetEntryRequest message or plain object
callback	GetEntryCallback Node-style callback called with the error, if any, and Entry

Returns
Type	Description
void

getEntry(request)

public getEntry(request: google.cloud.dataplex.v1.IGetEntryRequest): Promise<google.cloud.dataplex.v1.Entry>;

Calls GetEntry.

Parameter
Name	Description
request	IGetEntryRequest GetEntryRequest message or plain object

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

getEntryGroup(request, callback)

public getEntryGroup(request: google.cloud.dataplex.v1.IGetEntryGroupRequest, callback: google.cloud.dataplex.v1.CatalogService.GetEntryGroupCallback): void;

Calls GetEntryGroup.

Parameters
Name	Description
request	IGetEntryGroupRequest GetEntryGroupRequest message or plain object
callback	GetEntryGroupCallback Node-style callback called with the error, if any, and EntryGroup

Returns
Type	Description
void

getEntryGroup(request)

public getEntryGroup(request: google.cloud.dataplex.v1.IGetEntryGroupRequest): Promise<google.cloud.dataplex.v1.EntryGroup>;

Calls GetEntryGroup.

Parameter
Name	Description
request	IGetEntryGroupRequest GetEntryGroupRequest message or plain object

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

getEntryType(request, callback)

public getEntryType(request: google.cloud.dataplex.v1.IGetEntryTypeRequest, callback: google.cloud.dataplex.v1.CatalogService.GetEntryTypeCallback): void;

Calls GetEntryType.

Parameters
Name	Description
request	IGetEntryTypeRequest GetEntryTypeRequest message or plain object
callback	GetEntryTypeCallback Node-style callback called with the error, if any, and EntryType

Returns
Type	Description
void

getEntryType(request)

public getEntryType(request: google.cloud.dataplex.v1.IGetEntryTypeRequest): Promise<google.cloud.dataplex.v1.EntryType>;

Calls GetEntryType.

Parameter
Name	Description
request	IGetEntryTypeRequest GetEntryTypeRequest message or plain object

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

listAspectTypes(request, callback)

public listAspectTypes(request: google.cloud.dataplex.v1.IListAspectTypesRequest, callback: google.cloud.dataplex.v1.CatalogService.ListAspectTypesCallback): void;

Calls ListAspectTypes.

Parameters
Name	Description
request	IListAspectTypesRequest ListAspectTypesRequest message or plain object
callback	ListAspectTypesCallback Node-style callback called with the error, if any, and ListAspectTypesResponse

Returns
Type	Description
void

listAspectTypes(request)

public listAspectTypes(request: google.cloud.dataplex.v1.IListAspectTypesRequest): Promise<google.cloud.dataplex.v1.ListAspectTypesResponse>;

Calls ListAspectTypes.

Parameter
Name	Description
request	IListAspectTypesRequest ListAspectTypesRequest message or plain object

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

listEntries(request, callback)

public listEntries(request: google.cloud.dataplex.v1.IListEntriesRequest, callback: google.cloud.dataplex.v1.CatalogService.ListEntriesCallback): void;

Calls ListEntries.

Parameters
Name	Description
request	IListEntriesRequest ListEntriesRequest message or plain object
callback	ListEntriesCallback Node-style callback called with the error, if any, and ListEntriesResponse

Returns
Type	Description
void

listEntries(request)

public listEntries(request: google.cloud.dataplex.v1.IListEntriesRequest): Promise<google.cloud.dataplex.v1.ListEntriesResponse>;

Calls ListEntries.

Parameter
Name	Description
request	IListEntriesRequest ListEntriesRequest message or plain object

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

listEntryGroups(request, callback)

public listEntryGroups(request: google.cloud.dataplex.v1.IListEntryGroupsRequest, callback: google.cloud.dataplex.v1.CatalogService.ListEntryGroupsCallback): void;

Calls ListEntryGroups.

Parameters
Name	Description
request	IListEntryGroupsRequest ListEntryGroupsRequest message or plain object
callback	ListEntryGroupsCallback Node-style callback called with the error, if any, and ListEntryGroupsResponse

Returns
Type	Description
void

listEntryGroups(request)

public listEntryGroups(request: google.cloud.dataplex.v1.IListEntryGroupsRequest): Promise<google.cloud.dataplex.v1.ListEntryGroupsResponse>;

Calls ListEntryGroups.

Parameter
Name	Description
request	IListEntryGroupsRequest ListEntryGroupsRequest message or plain object

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

listEntryTypes(request, callback)

public listEntryTypes(request: google.cloud.dataplex.v1.IListEntryTypesRequest, callback: google.cloud.dataplex.v1.CatalogService.ListEntryTypesCallback): void;

Calls ListEntryTypes.

Parameters
Name	Description
request	IListEntryTypesRequest ListEntryTypesRequest message or plain object
callback	ListEntryTypesCallback Node-style callback called with the error, if any, and ListEntryTypesResponse

Returns
Type	Description
void

listEntryTypes(request)

public listEntryTypes(request: google.cloud.dataplex.v1.IListEntryTypesRequest): Promise<google.cloud.dataplex.v1.ListEntryTypesResponse>;

Calls ListEntryTypes.

Parameter
Name	Description
request	IListEntryTypesRequest ListEntryTypesRequest message or plain object

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

lookupEntry(request, callback)

public lookupEntry(request: google.cloud.dataplex.v1.ILookupEntryRequest, callback: google.cloud.dataplex.v1.CatalogService.LookupEntryCallback): void;

Calls LookupEntry.

Parameters
Name	Description
request	ILookupEntryRequest LookupEntryRequest message or plain object
callback	LookupEntryCallback Node-style callback called with the error, if any, and Entry

Returns
Type	Description
void

lookupEntry(request)

public lookupEntry(request: google.cloud.dataplex.v1.ILookupEntryRequest): Promise<google.cloud.dataplex.v1.Entry>;

Calls LookupEntry.

Parameter
Name	Description
request	ILookupEntryRequest LookupEntryRequest message or plain object

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

searchEntries(request, callback)

public searchEntries(request: google.cloud.dataplex.v1.ISearchEntriesRequest, callback: google.cloud.dataplex.v1.CatalogService.SearchEntriesCallback): void;

Calls SearchEntries.

Parameters
Name	Description
request	ISearchEntriesRequest SearchEntriesRequest message or plain object
callback	SearchEntriesCallback Node-style callback called with the error, if any, and SearchEntriesResponse

Returns
Type	Description
void

searchEntries(request)

public searchEntries(request: google.cloud.dataplex.v1.ISearchEntriesRequest): Promise<google.cloud.dataplex.v1.SearchEntriesResponse>;

Calls SearchEntries.

Parameter
Name	Description
request	ISearchEntriesRequest SearchEntriesRequest message or plain object

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

updateAspectType(request, callback)

public updateAspectType(request: google.cloud.dataplex.v1.IUpdateAspectTypeRequest, callback: google.cloud.dataplex.v1.CatalogService.UpdateAspectTypeCallback): void;

Calls UpdateAspectType.

Parameters
Name	Description
request	IUpdateAspectTypeRequest UpdateAspectTypeRequest message or plain object
callback	UpdateAspectTypeCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateAspectType(request)

public updateAspectType(request: google.cloud.dataplex.v1.IUpdateAspectTypeRequest): Promise<google.longrunning.Operation>;

Calls UpdateAspectType.

Parameter
Name	Description
request	IUpdateAspectTypeRequest UpdateAspectTypeRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateEntry(request, callback)

public updateEntry(request: google.cloud.dataplex.v1.IUpdateEntryRequest, callback: google.cloud.dataplex.v1.CatalogService.UpdateEntryCallback): void;

Calls UpdateEntry.

Parameters
Name	Description
request	IUpdateEntryRequest UpdateEntryRequest message or plain object
callback	UpdateEntryCallback Node-style callback called with the error, if any, and Entry

Returns
Type	Description
void

updateEntry(request)

public updateEntry(request: google.cloud.dataplex.v1.IUpdateEntryRequest): Promise<google.cloud.dataplex.v1.Entry>;

Calls UpdateEntry.

Parameter
Name	Description
request	IUpdateEntryRequest UpdateEntryRequest message or plain object

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

updateEntryGroup(request, callback)

public updateEntryGroup(request: google.cloud.dataplex.v1.IUpdateEntryGroupRequest, callback: google.cloud.dataplex.v1.CatalogService.UpdateEntryGroupCallback): void;

Calls UpdateEntryGroup.

Parameters
Name	Description
request	IUpdateEntryGroupRequest UpdateEntryGroupRequest message or plain object
callback	UpdateEntryGroupCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateEntryGroup(request)

public updateEntryGroup(request: google.cloud.dataplex.v1.IUpdateEntryGroupRequest): Promise<google.longrunning.Operation>;

Calls UpdateEntryGroup.

Parameter
Name	Description
request	IUpdateEntryGroupRequest UpdateEntryGroupRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateEntryType(request, callback)

public updateEntryType(request: google.cloud.dataplex.v1.IUpdateEntryTypeRequest, callback: google.cloud.dataplex.v1.CatalogService.UpdateEntryTypeCallback): void;

Calls UpdateEntryType.

Parameters
Name	Description
request	IUpdateEntryTypeRequest UpdateEntryTypeRequest message or plain object
callback	UpdateEntryTypeCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateEntryType(request)

public updateEntryType(request: google.cloud.dataplex.v1.IUpdateEntryTypeRequest): Promise<google.longrunning.Operation>;

Calls UpdateEntryType.

Parameter
Name	Description
request	IUpdateEntryTypeRequest UpdateEntryTypeRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise