Class IDS.IDSClient (2.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public class IDSClient : ClientBase<IDS.IDSClient>

Client for IDS

Inheritance

Object > ClientBase > ClientBase<IDS.IDSClient> > IDS.IDSClient

Namespace

Google.Cloud.Ids.V1

Assembly

Google.Cloud.Ids.V1.dll

Constructors

IDSClient()

protected IDSClient()

Protected parameterless constructor to allow creation of test doubles.

IDSClient(CallInvoker)

public IDSClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

IDSClient(ChannelBase)

public IDSClient(ChannelBase channel)

Creates a new client for IDS

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

IDSClient(ClientBase.ClientBaseConfiguration)

protected IDSClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateEndpoint(CreateEndpointRequest, CallOptions)

public virtual Operation CreateEndpoint(CreateEndpointRequest request, CallOptions options)

Creates a new Endpoint in a given project and location.

Parameters
NameDescription
requestCreateEndpointRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEndpoint(CreateEndpointRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateEndpoint(CreateEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new Endpoint in a given project and location.

Parameters
NameDescription
requestCreateEndpointRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateEndpointAsync(CreateEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEndpointAsync(CreateEndpointRequest request, CallOptions options)

Creates a new Endpoint in a given project and location.

Parameters
NameDescription
requestCreateEndpointRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateEndpointAsync(CreateEndpointRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEndpointAsync(CreateEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a new Endpoint in a given project and location.

Parameters
NameDescription
requestCreateEndpointRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteEndpoint(DeleteEndpointRequest, CallOptions)

public virtual Operation DeleteEndpoint(DeleteEndpointRequest request, CallOptions options)

Deletes a single Endpoint.

Parameters
NameDescription
requestDeleteEndpointRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEndpoint(DeleteEndpointRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteEndpoint(DeleteEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Endpoint.

Parameters
NameDescription
requestDeleteEndpointRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteEndpointAsync(DeleteEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteEndpointAsync(DeleteEndpointRequest request, CallOptions options)

Deletes a single Endpoint.

Parameters
NameDescription
requestDeleteEndpointRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteEndpointAsync(DeleteEndpointRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteEndpointAsync(DeleteEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a single Endpoint.

Parameters
NameDescription
requestDeleteEndpointRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetEndpoint(GetEndpointRequest, CallOptions)

public virtual Endpoint GetEndpoint(GetEndpointRequest request, CallOptions options)

Gets details of a single Endpoint.

Parameters
NameDescription
requestGetEndpointRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Endpoint

The response received from the server.

GetEndpoint(GetEndpointRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Endpoint GetEndpoint(GetEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Endpoint.

Parameters
NameDescription
requestGetEndpointRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Endpoint

The response received from the server.

GetEndpointAsync(GetEndpointRequest, CallOptions)

public virtual AsyncUnaryCall<Endpoint> GetEndpointAsync(GetEndpointRequest request, CallOptions options)

Gets details of a single Endpoint.

Parameters
NameDescription
requestGetEndpointRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Endpoint>

The call object.

GetEndpointAsync(GetEndpointRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Endpoint> GetEndpointAsync(GetEndpointRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single Endpoint.

Parameters
NameDescription
requestGetEndpointRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Endpoint>

The call object.

ListEndpoints(ListEndpointsRequest, CallOptions)

public virtual ListEndpointsResponse ListEndpoints(ListEndpointsRequest request, CallOptions options)

Lists Endpoints in a given project and location.

Parameters
NameDescription
requestListEndpointsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListEndpointsResponse

The response received from the server.

ListEndpoints(ListEndpointsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListEndpointsResponse ListEndpoints(ListEndpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Endpoints in a given project and location.

Parameters
NameDescription
requestListEndpointsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListEndpointsResponse

The response received from the server.

ListEndpointsAsync(ListEndpointsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEndpointsResponse> ListEndpointsAsync(ListEndpointsRequest request, CallOptions options)

Lists Endpoints in a given project and location.

Parameters
NameDescription
requestListEndpointsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListEndpointsResponse>

The call object.

ListEndpointsAsync(ListEndpointsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListEndpointsResponse> ListEndpointsAsync(ListEndpointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists Endpoints in a given project and location.

Parameters
NameDescription
requestListEndpointsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListEndpointsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override IDS.IDSClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
IDS.IDSClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Ids.V1.IDS.IDSClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)