Vision AI v1 API - Class StreamingService.StreamingServiceClient (1.0.0-beta01)

public class StreamingService.StreamingServiceClient : ClientBase<StreamingService.StreamingServiceClient>

Reference documentation and code samples for the Vision AI v1 API class StreamingService.StreamingServiceClient.

Client for StreamingService

Inheritance

object > ClientBase > ClientBaseStreamingServiceStreamingServiceClient > StreamingService.StreamingServiceClient

Inherited Members

ClientBase<StreamingService.StreamingServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.VisionAI.V1

Assembly

Google.Cloud.VisionAI.V1.dll

Constructors

StreamingServiceClient()

protected StreamingServiceClient()

Protected parameterless constructor to allow creation of test doubles.

StreamingServiceClient(CallInvoker)

public StreamingServiceClient(CallInvoker callInvoker)

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

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

StreamingServiceClient(ChannelBase)

public StreamingServiceClient(ChannelBase channel)

Creates a new client for StreamingService

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

StreamingServiceClient(ClientBaseConfiguration)

protected StreamingServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

AcquireLease(AcquireLeaseRequest, CallOptions)

public virtual Lease AcquireLease(AcquireLeaseRequest request, CallOptions options)

AcquireLease acquires a lease.

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

Returns
Type	Description
Lease	The response received from the server.

AcquireLease(AcquireLeaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Lease AcquireLease(AcquireLeaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

AcquireLease acquires a lease.

Parameters
Name	Description
request	AcquireLeaseRequest 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
Lease	The response received from the server.

AcquireLeaseAsync(AcquireLeaseRequest, CallOptions)

public virtual AsyncUnaryCall<Lease> AcquireLeaseAsync(AcquireLeaseRequest request, CallOptions options)

AcquireLease acquires a lease.

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

Returns
Type	Description
AsyncUnaryCallLease	The call object.

AcquireLeaseAsync(AcquireLeaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Lease> AcquireLeaseAsync(AcquireLeaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

AcquireLease acquires a lease.

Parameters
Name	Description
request	AcquireLeaseRequest 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
AsyncUnaryCallLease	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.

NewInstance(ClientBaseConfiguration)

protected override StreamingService.StreamingServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
StreamingServiceStreamingServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.VisionAI.V1.StreamingService.StreamingServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ReceiveEvents(CallOptions)

public virtual AsyncDuplexStreamingCall<ReceiveEventsRequest, ReceiveEventsResponse> ReceiveEvents(CallOptions options)

Receive events given the stream name.

Parameter
Name	Description
options	CallOptions The options for the call.

Returns
Type	Description
AsyncDuplexStreamingCallReceiveEventsRequestReceiveEventsResponse	The call object.

ReceiveEvents(Metadata, DateTime?, CancellationToken)

public virtual AsyncDuplexStreamingCall<ReceiveEventsRequest, ReceiveEventsResponse> ReceiveEvents(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Receive events given the stream name.

Parameters
Name	Description
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
AsyncDuplexStreamingCallReceiveEventsRequestReceiveEventsResponse	The call object.

ReceivePackets(CallOptions)

public virtual AsyncDuplexStreamingCall<ReceivePacketsRequest, ReceivePacketsResponse> ReceivePackets(CallOptions options)

Receive packets from the series.

Parameter
Name	Description
options	CallOptions The options for the call.

Returns
Type	Description
AsyncDuplexStreamingCallReceivePacketsRequestReceivePacketsResponse	The call object.

ReceivePackets(Metadata, DateTime?, CancellationToken)

public virtual AsyncDuplexStreamingCall<ReceivePacketsRequest, ReceivePacketsResponse> ReceivePackets(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Receive packets from the series.

Parameters
Name	Description
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
AsyncDuplexStreamingCallReceivePacketsRequestReceivePacketsResponse	The call object.

ReleaseLease(ReleaseLeaseRequest, CallOptions)

public virtual ReleaseLeaseResponse ReleaseLease(ReleaseLeaseRequest request, CallOptions options)

RleaseLease releases a lease.

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

Returns
Type	Description
ReleaseLeaseResponse	The response received from the server.

ReleaseLease(ReleaseLeaseRequest, Metadata, DateTime?, CancellationToken)

public virtual ReleaseLeaseResponse ReleaseLease(ReleaseLeaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

RleaseLease releases a lease.

Parameters
Name	Description
request	ReleaseLeaseRequest 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
ReleaseLeaseResponse	The response received from the server.

ReleaseLeaseAsync(ReleaseLeaseRequest, CallOptions)

public virtual AsyncUnaryCall<ReleaseLeaseResponse> ReleaseLeaseAsync(ReleaseLeaseRequest request, CallOptions options)

RleaseLease releases a lease.

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

Returns
Type	Description
AsyncUnaryCallReleaseLeaseResponse	The call object.

ReleaseLeaseAsync(ReleaseLeaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReleaseLeaseResponse> ReleaseLeaseAsync(ReleaseLeaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

RleaseLease releases a lease.

Parameters
Name	Description
request	ReleaseLeaseRequest 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
AsyncUnaryCallReleaseLeaseResponse	The call object.

RenewLease(RenewLeaseRequest, CallOptions)

public virtual Lease RenewLease(RenewLeaseRequest request, CallOptions options)

RenewLease renews a lease.

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

Returns
Type	Description
Lease	The response received from the server.

RenewLease(RenewLeaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Lease RenewLease(RenewLeaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

RenewLease renews a lease.

Parameters
Name	Description
request	RenewLeaseRequest 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
Lease	The response received from the server.

RenewLeaseAsync(RenewLeaseRequest, CallOptions)

public virtual AsyncUnaryCall<Lease> RenewLeaseAsync(RenewLeaseRequest request, CallOptions options)

RenewLease renews a lease.

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

Returns
Type	Description
AsyncUnaryCallLease	The call object.

RenewLeaseAsync(RenewLeaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Lease> RenewLeaseAsync(RenewLeaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

RenewLease renews a lease.

Parameters
Name	Description
request	RenewLeaseRequest 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
AsyncUnaryCallLease	The call object.

SendPackets(CallOptions)

public virtual AsyncDuplexStreamingCall<SendPacketsRequest, SendPacketsResponse> SendPackets(CallOptions options)

Send packets to the series.

Parameter
Name	Description
options	CallOptions The options for the call.

Returns
Type	Description
AsyncDuplexStreamingCallSendPacketsRequestSendPacketsResponse	The call object.

SendPackets(Metadata, DateTime?, CancellationToken)

public virtual AsyncDuplexStreamingCall<SendPacketsRequest, SendPacketsResponse> SendPackets(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Send packets to the series.

Parameters
Name	Description
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
AsyncDuplexStreamingCallSendPacketsRequestSendPacketsResponse	The call object.