API hub v1 API - Class ApiHubCurate.ApiHubCurateClient (1.1.0) 

public class ApiHubCurate.ApiHubCurateClient : ClientBase<ApiHubCurate.ApiHubCurateClient>

Reference documentation and code samples for the API hub v1 API class ApiHubCurate.ApiHubCurateClient.

Client for ApiHubCurate

Inheritance

object > ClientBase > ClientBaseApiHubCurateApiHubCurateClient > ApiHubCurate.ApiHubCurateClient

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

ApiHubCurateClient()

protected ApiHubCurateClient()

Protected parameterless constructor to allow creation of test doubles.

ApiHubCurateClient(CallInvoker)

public ApiHubCurateClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

ApiHubCurateClient(ChannelBase)

public ApiHubCurateClient(ChannelBase channel)

Creates a new client for ApiHubCurate

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

ApiHubCurateClient(ClientBaseConfiguration)

protected ApiHubCurateClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateCuration(CreateCurationRequest, CallOptions)

public virtual Curation CreateCuration(CreateCurationRequest request, CallOptions options)

Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.

Parameters
Name Description
request CreateCurationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Curation

The response received from the server.

CreateCuration(CreateCurationRequest, Metadata, DateTime?, CancellationToken)

public virtual Curation CreateCuration(CreateCurationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.

Parameters
Name Description
request CreateCurationRequest

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
Curation

The response received from the server.

CreateCurationAsync(CreateCurationRequest, CallOptions)

public virtual AsyncUnaryCall<Curation> CreateCurationAsync(CreateCurationRequest request, CallOptions options)

Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.

Parameters
Name Description
request CreateCurationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCuration

The call object.

CreateCurationAsync(CreateCurationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Curation> CreateCurationAsync(CreateCurationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.

Parameters
Name Description
request CreateCurationRequest

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
AsyncUnaryCallCuration

The call object.

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.

DeleteCuration(DeleteCurationRequest, CallOptions)

public virtual Empty DeleteCuration(DeleteCurationRequest request, CallOptions options)

Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.

Parameters
Name Description
request DeleteCurationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Empty

The response received from the server.

DeleteCuration(DeleteCurationRequest, Metadata, DateTime?, CancellationToken)

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

Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.

Parameters
Name Description
request DeleteCurationRequest

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.

DeleteCurationAsync(DeleteCurationRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteCurationAsync(DeleteCurationRequest request, CallOptions options)

Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.

Parameters
Name Description
request DeleteCurationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteCurationAsync(DeleteCurationRequest, Metadata, DateTime?, CancellationToken)

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

Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.

Parameters
Name Description
request DeleteCurationRequest

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.

GetCuration(GetCurationRequest, CallOptions)

public virtual Curation GetCuration(GetCurationRequest request, CallOptions options)

Get curation resource details.

Parameters
Name Description
request GetCurationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Curation

The response received from the server.

GetCuration(GetCurationRequest, Metadata, DateTime?, CancellationToken)

public virtual Curation GetCuration(GetCurationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get curation resource details.

Parameters
Name Description
request GetCurationRequest

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
Curation

The response received from the server.

GetCurationAsync(GetCurationRequest, CallOptions)

public virtual AsyncUnaryCall<Curation> GetCurationAsync(GetCurationRequest request, CallOptions options)

Get curation resource details.

Parameters
Name Description
request GetCurationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCuration

The call object.

GetCurationAsync(GetCurationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Curation> GetCurationAsync(GetCurationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Get curation resource details.

Parameters
Name Description
request GetCurationRequest

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
AsyncUnaryCallCuration

The call object.

ListCurations(ListCurationsRequest, CallOptions)

public virtual ListCurationsResponse ListCurations(ListCurationsRequest request, CallOptions options)

List curation resources in the API hub.

Parameters
Name Description
request ListCurationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListCurationsResponse

The response received from the server.

ListCurations(ListCurationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCurationsResponse ListCurations(ListCurationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List curation resources in the API hub.

Parameters
Name Description
request ListCurationsRequest

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
ListCurationsResponse

The response received from the server.

ListCurationsAsync(ListCurationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCurationsResponse> ListCurationsAsync(ListCurationsRequest request, CallOptions options)

List curation resources in the API hub.

Parameters
Name Description
request ListCurationsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallListCurationsResponse

The call object.

ListCurationsAsync(ListCurationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCurationsResponse> ListCurationsAsync(ListCurationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List curation resources in the API hub.

Parameters
Name Description
request ListCurationsRequest

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
AsyncUnaryCallListCurationsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override ApiHubCurate.ApiHubCurateClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
ApiHubCurateApiHubCurateClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.ApiHub.V1.ApiHubCurate.ApiHubCurateClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateCuration(UpdateCurationRequest, CallOptions)

public virtual Curation UpdateCuration(UpdateCurationRequest request, CallOptions options)

Update a curation resource in the API hub. The following fields in the [curation][google.cloud.apihub.v1.Curation] can be updated:

  • [display_name][google.cloud.apihub.v1.Curation.display_name]
  • [description][google.cloud.apihub.v1.Curation.description]

The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateCurationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Curation

The response received from the server.

UpdateCuration(UpdateCurationRequest, Metadata, DateTime?, CancellationToken)

public virtual Curation UpdateCuration(UpdateCurationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a curation resource in the API hub. The following fields in the [curation][google.cloud.apihub.v1.Curation] can be updated:

  • [display_name][google.cloud.apihub.v1.Curation.display_name]
  • [description][google.cloud.apihub.v1.Curation.description]

The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateCurationRequest

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
Curation

The response received from the server.

UpdateCurationAsync(UpdateCurationRequest, CallOptions)

public virtual AsyncUnaryCall<Curation> UpdateCurationAsync(UpdateCurationRequest request, CallOptions options)

Update a curation resource in the API hub. The following fields in the [curation][google.cloud.apihub.v1.Curation] can be updated:

  • [display_name][google.cloud.apihub.v1.Curation.display_name]
  • [description][google.cloud.apihub.v1.Curation.description]

The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateCurationRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCallCuration

The call object.

UpdateCurationAsync(UpdateCurationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Curation> UpdateCurationAsync(UpdateCurationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Update a curation resource in the API hub. The following fields in the [curation][google.cloud.apihub.v1.Curation] can be updated:

  • [display_name][google.cloud.apihub.v1.Curation.display_name]
  • [description][google.cloud.apihub.v1.Curation.description]

The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated.

Parameters
Name Description
request UpdateCurationRequest

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
AsyncUnaryCallCuration

The call object.