Cloud Dataplex v1 API - Class MetadataService.MetadataServiceClient (3.3.0)

Version latest

• 3.3.0 (latest)
• 3.2.0
• 3.1.0
• 3.0.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

public class MetadataService.MetadataServiceClient : ClientBase<MetadataService.MetadataServiceClient>

Reference documentation and code samples for the Cloud Dataplex v1 API class MetadataService.MetadataServiceClient.

Client for MetadataService

Inheritance

object > ClientBase > ClientBaseMetadataServiceMetadataServiceClient > MetadataService.MetadataServiceClient

Inherited Members

ClientBase<MetadataService.MetadataServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

MetadataServiceClient()

protected MetadataServiceClient()

Protected parameterless constructor to allow creation of test doubles.

MetadataServiceClient(CallInvoker)

public MetadataServiceClient(CallInvoker callInvoker)

Creates a new client for MetadataService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

MetadataServiceClient(ChannelBase)

public MetadataServiceClient(ChannelBase channel)

Creates a new client for MetadataService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

MetadataServiceClient(ClientBaseConfiguration)

protected MetadataServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateEntity(CreateEntityRequest, CallOptions)

public virtual Entity CreateEntity(CreateEntityRequest request, CallOptions options)

Create a metadata entity.

Parameters
Name	Description
request	CreateEntityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Entity	The response received from the server.

CreateEntity(CreateEntityRequest, Metadata, DateTime?, CancellationToken)

public virtual Entity CreateEntity(CreateEntityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a metadata entity.

Parameters
Name	Description
request	CreateEntityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Entity	The response received from the server.

CreateEntityAsync(CreateEntityRequest, CallOptions)

public virtual AsyncUnaryCall<Entity> CreateEntityAsync(CreateEntityRequest request, CallOptions options)

Create a metadata entity.

Parameters
Name	Description
request	CreateEntityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEntity	The call object.

CreateEntityAsync(CreateEntityRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entity> CreateEntityAsync(CreateEntityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a metadata entity.

Parameters
Name	Description
request	CreateEntityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEntity	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreatePartition(CreatePartitionRequest, CallOptions)

public virtual Partition CreatePartition(CreatePartitionRequest request, CallOptions options)

Create a metadata partition.

Parameters
Name	Description
request	CreatePartitionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Partition	The response received from the server.

CreatePartition(CreatePartitionRequest, Metadata, DateTime?, CancellationToken)

public virtual Partition CreatePartition(CreatePartitionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a metadata partition.

Parameters
Name	Description
request	CreatePartitionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Partition	The response received from the server.

CreatePartitionAsync(CreatePartitionRequest, CallOptions)

public virtual AsyncUnaryCall<Partition> CreatePartitionAsync(CreatePartitionRequest request, CallOptions options)

Create a metadata partition.

Parameters
Name	Description
request	CreatePartitionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPartition	The call object.

CreatePartitionAsync(CreatePartitionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Partition> CreatePartitionAsync(CreatePartitionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a metadata partition.

Parameters
Name	Description
request	CreatePartitionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPartition	The call object.

DeleteEntity(DeleteEntityRequest, CallOptions)

public virtual Empty DeleteEntity(DeleteEntityRequest request, CallOptions options)

Delete a metadata entity.

Parameters
Name	Description
request	DeleteEntityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteEntity(DeleteEntityRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteEntity(DeleteEntityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete a metadata entity.

Parameters
Name	Description
request	DeleteEntityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeleteEntityAsync(DeleteEntityRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteEntityAsync(DeleteEntityRequest request, CallOptions options)

Delete a metadata entity.

Parameters
Name	Description
request	DeleteEntityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteEntityAsync(DeleteEntityRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteEntityAsync(DeleteEntityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete a metadata entity.

Parameters
Name	Description
request	DeleteEntityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeletePartition(DeletePartitionRequest, CallOptions)

public virtual Empty DeletePartition(DeletePartitionRequest request, CallOptions options)

Delete a metadata partition.

Parameters
Name	Description
request	DeletePartitionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Empty	The response received from the server.

DeletePartition(DeletePartitionRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeletePartition(DeletePartitionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete a metadata partition.

Parameters
Name	Description
request	DeletePartitionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Empty	The response received from the server.

DeletePartitionAsync(DeletePartitionRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeletePartitionAsync(DeletePartitionRequest request, CallOptions options)

Delete a metadata partition.

Parameters
Name	Description
request	DeletePartitionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeletePartitionAsync(DeletePartitionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeletePartitionAsync(DeletePartitionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Delete a metadata partition.

Parameters
Name	Description
request	DeletePartitionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

GetEntity(GetEntityRequest, CallOptions)

public virtual Entity GetEntity(GetEntityRequest request, CallOptions options)

Get a metadata entity.

Parameters
Name	Description
request	GetEntityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Entity	The response received from the server.

GetEntity(GetEntityRequest, Metadata, DateTime?, CancellationToken)

public virtual Entity GetEntity(GetEntityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a metadata entity.

Parameters
Name	Description
request	GetEntityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Entity	The response received from the server.

GetEntityAsync(GetEntityRequest, CallOptions)

public virtual AsyncUnaryCall<Entity> GetEntityAsync(GetEntityRequest request, CallOptions options)

Get a metadata entity.

Parameters
Name	Description
request	GetEntityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEntity	The call object.

GetEntityAsync(GetEntityRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entity> GetEntityAsync(GetEntityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a metadata entity.

Parameters
Name	Description
request	GetEntityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEntity	The call object.

GetPartition(GetPartitionRequest, CallOptions)

public virtual Partition GetPartition(GetPartitionRequest request, CallOptions options)

Get a metadata partition of an entity.

Parameters
Name	Description
request	GetPartitionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Partition	The response received from the server.

GetPartition(GetPartitionRequest, Metadata, DateTime?, CancellationToken)

public virtual Partition GetPartition(GetPartitionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a metadata partition of an entity.

Parameters
Name	Description
request	GetPartitionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Partition	The response received from the server.

GetPartitionAsync(GetPartitionRequest, CallOptions)

public virtual AsyncUnaryCall<Partition> GetPartitionAsync(GetPartitionRequest request, CallOptions options)

Get a metadata partition of an entity.

Parameters
Name	Description
request	GetPartitionRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallPartition	The call object.

GetPartitionAsync(GetPartitionRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Partition> GetPartitionAsync(GetPartitionRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get a metadata partition of an entity.

Parameters
Name	Description
request	GetPartitionRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallPartition	The call object.

ListEntities(ListEntitiesRequest, CallOptions)

public virtual ListEntitiesResponse ListEntities(ListEntitiesRequest request, CallOptions options)

List metadata entities in a zone.

Parameters
Name	Description
request	ListEntitiesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListEntitiesResponse	The response received from the server.

ListEntities(ListEntitiesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListEntitiesResponse ListEntities(ListEntitiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List metadata entities in a zone.

Parameters
Name	Description
request	ListEntitiesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListEntitiesResponse	The response received from the server.

ListEntitiesAsync(ListEntitiesRequest, CallOptions)

public virtual AsyncUnaryCall<ListEntitiesResponse> ListEntitiesAsync(ListEntitiesRequest request, CallOptions options)

List metadata entities in a zone.

Parameters
Name	Description
request	ListEntitiesRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListEntitiesResponse	The call object.

ListEntitiesAsync(ListEntitiesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListEntitiesResponse> ListEntitiesAsync(ListEntitiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List metadata entities in a zone.

Parameters
Name	Description
request	ListEntitiesRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListEntitiesResponse	The call object.

ListPartitions(ListPartitionsRequest, CallOptions)

public virtual ListPartitionsResponse ListPartitions(ListPartitionsRequest request, CallOptions options)

List metadata partitions of an entity.

Parameters
Name	Description
request	ListPartitionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListPartitionsResponse	The response received from the server.

ListPartitions(ListPartitionsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListPartitionsResponse ListPartitions(ListPartitionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List metadata partitions of an entity.

Parameters
Name	Description
request	ListPartitionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListPartitionsResponse	The response received from the server.

ListPartitionsAsync(ListPartitionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListPartitionsResponse> ListPartitionsAsync(ListPartitionsRequest request, CallOptions options)

List metadata partitions of an entity.

Parameters
Name	Description
request	ListPartitionsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListPartitionsResponse	The call object.

ListPartitionsAsync(ListPartitionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListPartitionsResponse> ListPartitionsAsync(ListPartitionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List metadata partitions of an entity.

Parameters
Name	Description
request	ListPartitionsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListPartitionsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override MetadataService.MetadataServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
MetadataServiceMetadataServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dataplex.V1.MetadataService.MetadataServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateEntity(UpdateEntityRequest, CallOptions)

public virtual Entity UpdateEntity(UpdateEntityRequest request, CallOptions options)

Update a metadata entity. Only supports full resource update.

Parameters
Name	Description
request	UpdateEntityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Entity	The response received from the server.

UpdateEntity(UpdateEntityRequest, Metadata, DateTime?, CancellationToken)

public virtual Entity UpdateEntity(UpdateEntityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a metadata entity. Only supports full resource update.

Parameters
Name	Description
request	UpdateEntityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Entity	The response received from the server.

UpdateEntityAsync(UpdateEntityRequest, CallOptions)

public virtual AsyncUnaryCall<Entity> UpdateEntityAsync(UpdateEntityRequest request, CallOptions options)

Update a metadata entity. Only supports full resource update.

Parameters
Name	Description
request	UpdateEntityRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallEntity	The call object.

UpdateEntityAsync(UpdateEntityRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Entity> UpdateEntityAsync(UpdateEntityRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a metadata entity. Only supports full resource update.

Parameters
Name	Description
request	UpdateEntityRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallEntity	The call object.