Cloud IDS v1 API - Class IDS.IDSClient (2.3.0)

public class IDS.IDSClient : ClientBase<IDS.IDSClient>

Reference documentation and code samples for the Cloud IDS v1 API class IDS.IDSClient.

Client for IDS

Inheritance

object > ClientBase > ClientBase IDS IDSClient > IDS.IDSClient

Inherited Members

ClientBase<IDS.IDSClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

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
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

IDSClient(ChannelBase)

public IDSClient(ChannelBase channel)

Creates a new client for IDS

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

IDSClient(ClientBaseConfiguration)

protected IDSClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` 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
Name	Description
`request`	`CreateEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateEndpoint(CreateEndpointRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Endpoint in a given project and location.

Parameters
Name	Description
`request`	`CreateEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`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
`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
Name	Description
`request`	`CreateEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

CreateEndpointAsync(CreateEndpointRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new Endpoint in a given project and location.

Parameters
Name	Description
`request`	`CreateEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`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
`AsyncUnaryCallOperation`	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
Type	Description
`OperationsOperationsClient`	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
Name	Description
`request`	`DeleteEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteEndpoint(DeleteEndpointRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Endpoint.

Parameters
Name	Description
`request`	`DeleteEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`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
`Operation`	The response received from the server.

DeleteEndpointAsync(DeleteEndpointRequest, CallOptions)

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

Deletes a single Endpoint.

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

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeleteEndpointAsync(DeleteEndpointRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Endpoint.

Parameters
Name	Description
`request`	`DeleteEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`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
`AsyncUnaryCallOperation`	The call object.

GetEndpoint(GetEndpointRequest, CallOptions)

public virtual Endpoint GetEndpoint(GetEndpointRequest request, CallOptions options)

Gets details of a single Endpoint.

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

Returns
Type	Description
`Endpoint`	The response received from the server.

GetEndpoint(GetEndpointRequest, Metadata, DateTime?, CancellationToken)

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

Gets details of a single Endpoint.

Parameters
Name	Description
`request`	`GetEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`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
`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
Name	Description
`request`	`GetEndpointRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEndpoint`	The call object.

GetEndpointAsync(GetEndpointRequest, Metadata, DateTime?, CancellationToken)

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

Gets details of a single Endpoint.

Parameters
Name	Description
`request`	`GetEndpointRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`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
`AsyncUnaryCallEndpoint`	The call object.

ListEndpoints(ListEndpointsRequest, CallOptions)

public virtual ListEndpointsResponse ListEndpoints(ListEndpointsRequest request, CallOptions options)

Lists Endpoints in a given project and location.

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

Returns
Type	Description
`ListEndpointsResponse`	The response received from the server.

ListEndpoints(ListEndpointsRequest, Metadata, DateTime?, CancellationToken)

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

Lists Endpoints in a given project and location.

Parameters
Name	Description
`request`	`ListEndpointsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`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
`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
Name	Description
`request`	`ListEndpointsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListEndpointsResponse`	The call object.

ListEndpointsAsync(ListEndpointsRequest, Metadata, DateTime?, CancellationToken)

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

Lists Endpoints in a given project and location.

Parameters
Name	Description
`request`	`ListEndpointsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`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
`AsyncUnaryCallListEndpointsResponse`	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`IDSIDSClient`

Overrides

ClientBase<IDS.IDSClient>.NewInstance(ClientBase.ClientBaseConfiguration)