App Optimize v1beta API - Class AppOptimize.AppOptimizeClient (1.0.0-beta01)

public class AppOptimize.AppOptimizeClient : ClientBase<AppOptimize.AppOptimizeClient>

Reference documentation and code samples for the App Optimize v1beta API class AppOptimize.AppOptimizeClient.

Client for AppOptimize

Inheritance

object > ClientBase > ClientBaseAppOptimizeAppOptimizeClient > AppOptimize.AppOptimizeClient

Namespace

Google.Cloud.AppOptimize.V1Beta

Assembly

Google.Cloud.AppOptimize.V1Beta.dll

Constructors

AppOptimizeClient()

protected AppOptimizeClient()

Protected parameterless constructor to allow creation of test doubles.

AppOptimizeClient(CallInvoker)

public AppOptimizeClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

AppOptimizeClient(ChannelBase)

public AppOptimizeClient(ChannelBase channel)

Creates a new client for AppOptimize

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

AppOptimizeClient(ClientBaseConfiguration)

protected AppOptimizeClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

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.

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.

CreateReport(CreateReportRequest, CallOptions)

public virtual Operation CreateReport(CreateReportRequest request, CallOptions options)

Creates a new report.

This initiates a long-running operation that, upon completion, results in a report resource. Once the report is created, its results can be read via ReadReport.

Parameters
Name Description
request CreateReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateReport(CreateReportRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new report.

This initiates a long-running operation that, upon completion, results in a report resource. Once the report is created, its results can be read via ReadReport.

Parameters
Name Description
request CreateReportRequest

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
Operation

The response received from the server.

CreateReportAsync(CreateReportRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateReportAsync(CreateReportRequest request, CallOptions options)

Creates a new report.

This initiates a long-running operation that, upon completion, results in a report resource. Once the report is created, its results can be read via ReadReport.

Parameters
Name Description
request CreateReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateReportAsync(CreateReportRequest, Metadata, DateTime?, CancellationToken)

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

Creates a new report.

This initiates a long-running operation that, upon completion, results in a report resource. Once the report is created, its results can be read via ReadReport.

Parameters
Name Description
request CreateReportRequest

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
AsyncUnaryCallOperation

The call object.

DeleteReport(DeleteReportRequest, CallOptions)

public virtual Empty DeleteReport(DeleteReportRequest request, CallOptions options)

Deletes the specified report.

Parameters
Name Description
request DeleteReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Empty

The response received from the server.

DeleteReport(DeleteReportRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified report.

Parameters
Name Description
request DeleteReportRequest

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.

DeleteReportAsync(DeleteReportRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteReportAsync(DeleteReportRequest request, CallOptions options)

Deletes the specified report.

Parameters
Name Description
request DeleteReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallEmpty

The call object.

DeleteReportAsync(DeleteReportRequest, Metadata, DateTime?, CancellationToken)

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

Deletes the specified report.

Parameters
Name Description
request DeleteReportRequest

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.

GetReport(GetReportRequest, CallOptions)

public virtual Report GetReport(GetReportRequest request, CallOptions options)

Retrieves the details of a report configuration.

Parameters
Name Description
request GetReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Report

The response received from the server.

GetReport(GetReportRequest, Metadata, DateTime?, CancellationToken)

public virtual Report GetReport(GetReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the details of a report configuration.

Parameters
Name Description
request GetReportRequest

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
Report

The response received from the server.

GetReportAsync(GetReportRequest, CallOptions)

public virtual AsyncUnaryCall<Report> GetReportAsync(GetReportRequest request, CallOptions options)

Retrieves the details of a report configuration.

Parameters
Name Description
request GetReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallReport

The call object.

GetReportAsync(GetReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Report> GetReportAsync(GetReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves the details of a report configuration.

Parameters
Name Description
request GetReportRequest

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
AsyncUnaryCallReport

The call object.

ListReports(ListReportsRequest, CallOptions)

public virtual ListReportsResponse ListReports(ListReportsRequest request, CallOptions options)

Lists reports within a given project.

Parameters
Name Description
request ListReportsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListReportsResponse

The response received from the server.

ListReports(ListReportsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListReportsResponse ListReports(ListReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists reports within a given project.

Parameters
Name Description
request ListReportsRequest

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
ListReportsResponse

The response received from the server.

ListReportsAsync(ListReportsRequest, CallOptions)

public virtual AsyncUnaryCall<ListReportsResponse> ListReportsAsync(ListReportsRequest request, CallOptions options)

Lists reports within a given project.

Parameters
Name Description
request ListReportsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListReportsResponse

The call object.

ListReportsAsync(ListReportsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListReportsResponse> ListReportsAsync(ListReportsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists reports within a given project.

Parameters
Name Description
request ListReportsRequest

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
AsyncUnaryCallListReportsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override AppOptimize.AppOptimizeClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
AppOptimizeAppOptimizeClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AppOptimize.V1Beta.AppOptimize.AppOptimizeClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ReadReport(ReadReportRequest, CallOptions)

public virtual ReadReportResponse ReadReport(ReadReportRequest request, CallOptions options)

Reads data within a specified report.

Parameters
Name Description
request ReadReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ReadReportResponse

The response received from the server.

ReadReport(ReadReportRequest, Metadata, DateTime?, CancellationToken)

public virtual ReadReportResponse ReadReport(ReadReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Reads data within a specified report.

Parameters
Name Description
request ReadReportRequest

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
ReadReportResponse

The response received from the server.

ReadReportAsync(ReadReportRequest, CallOptions)

public virtual AsyncUnaryCall<ReadReportResponse> ReadReportAsync(ReadReportRequest request, CallOptions options)

Reads data within a specified report.

Parameters
Name Description
request ReadReportRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallReadReportResponse

The call object.

ReadReportAsync(ReadReportRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReadReportResponse> ReadReportAsync(ReadReportRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Reads data within a specified report.

Parameters
Name Description
request ReadReportRequest

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
AsyncUnaryCallReadReportResponse

The call object.