Google Cloud Storage Insights v1 API - Class StorageInsights.StorageInsightsClient (1.0.0)

public class StorageInsights.StorageInsightsClient : ClientBase<StorageInsights.StorageInsightsClient>

Reference documentation and code samples for the Google Cloud Storage Insights v1 API class StorageInsights.StorageInsightsClient.

Client for StorageInsights

Inheritance

object > ClientBase > ClientBaseStorageInsightsStorageInsightsClient > StorageInsights.StorageInsightsClient

Namespace

Google.Cloud.StorageInsights.V1

Assembly

Google.Cloud.StorageInsights.V1.dll

Constructors

StorageInsightsClient()

protected StorageInsightsClient()

Protected parameterless constructor to allow creation of test doubles.

StorageInsightsClient(CallInvoker)

public StorageInsightsClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

StorageInsightsClient(ChannelBase)

public StorageInsightsClient(ChannelBase channel)

Creates a new client for StorageInsights

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

StorageInsightsClient(ClientBaseConfiguration)

protected StorageInsightsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

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
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateReportConfig(CreateReportConfigRequest, CallOptions)

public virtual ReportConfig CreateReportConfig(CreateReportConfigRequest request, CallOptions options)

Creates a new ReportConfig in a given project and location.

Parameters
NameDescription
requestCreateReportConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ReportConfig

The response received from the server.

CreateReportConfig(CreateReportConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual ReportConfig CreateReportConfig(CreateReportConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new ReportConfig in a given project and location.

Parameters
NameDescription
requestCreateReportConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
ReportConfig

The response received from the server.

CreateReportConfigAsync(CreateReportConfigRequest, CallOptions)

public virtual AsyncUnaryCall<ReportConfig> CreateReportConfigAsync(CreateReportConfigRequest request, CallOptions options)

Creates a new ReportConfig in a given project and location.

Parameters
NameDescription
requestCreateReportConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallReportConfig

The call object.

CreateReportConfigAsync(CreateReportConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReportConfig> CreateReportConfigAsync(CreateReportConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new ReportConfig in a given project and location.

Parameters
NameDescription
requestCreateReportConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallReportConfig

The call object.

DeleteReportConfig(DeleteReportConfigRequest, CallOptions)

public virtual Empty DeleteReportConfig(DeleteReportConfigRequest request, CallOptions options)

Deletes a single ReportConfig.

Parameters
NameDescription
requestDeleteReportConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteReportConfig(DeleteReportConfigRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single ReportConfig.

Parameters
NameDescription
requestDeleteReportConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
Empty

The response received from the server.

DeleteReportConfigAsync(DeleteReportConfigRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteReportConfigAsync(DeleteReportConfigRequest request, CallOptions options)

Deletes a single ReportConfig.

Parameters
NameDescription
requestDeleteReportConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteReportConfigAsync(DeleteReportConfigRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single ReportConfig.

Parameters
NameDescription
requestDeleteReportConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallEmpty

The call object.

GetReportConfig(GetReportConfigRequest, CallOptions)

public virtual ReportConfig GetReportConfig(GetReportConfigRequest request, CallOptions options)

Gets details of a single ReportConfig.

Parameters
NameDescription
requestGetReportConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ReportConfig

The response received from the server.

GetReportConfig(GetReportConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual ReportConfig GetReportConfig(GetReportConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single ReportConfig.

Parameters
NameDescription
requestGetReportConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
ReportConfig

The response received from the server.

GetReportConfigAsync(GetReportConfigRequest, CallOptions)

public virtual AsyncUnaryCall<ReportConfig> GetReportConfigAsync(GetReportConfigRequest request, CallOptions options)

Gets details of a single ReportConfig.

Parameters
NameDescription
requestGetReportConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallReportConfig

The call object.

GetReportConfigAsync(GetReportConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReportConfig> GetReportConfigAsync(GetReportConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single ReportConfig.

Parameters
NameDescription
requestGetReportConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallReportConfig

The call object.

GetReportDetail(GetReportDetailRequest, CallOptions)

public virtual ReportDetail GetReportDetail(GetReportDetailRequest request, CallOptions options)

Gets details of a single ReportDetail.

Parameters
NameDescription
requestGetReportDetailRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ReportDetail

The response received from the server.

GetReportDetail(GetReportDetailRequest, Metadata, DateTime?, CancellationToken)

public virtual ReportDetail GetReportDetail(GetReportDetailRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single ReportDetail.

Parameters
NameDescription
requestGetReportDetailRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
ReportDetail

The response received from the server.

GetReportDetailAsync(GetReportDetailRequest, CallOptions)

public virtual AsyncUnaryCall<ReportDetail> GetReportDetailAsync(GetReportDetailRequest request, CallOptions options)

Gets details of a single ReportDetail.

Parameters
NameDescription
requestGetReportDetailRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallReportDetail

The call object.

GetReportDetailAsync(GetReportDetailRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReportDetail> GetReportDetailAsync(GetReportDetailRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single ReportDetail.

Parameters
NameDescription
requestGetReportDetailRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallReportDetail

The call object.

ListReportConfigs(ListReportConfigsRequest, CallOptions)

public virtual ListReportConfigsResponse ListReportConfigs(ListReportConfigsRequest request, CallOptions options)

Lists ReportConfigs in a given project and location.

Parameters
NameDescription
requestListReportConfigsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListReportConfigsResponse

The response received from the server.

ListReportConfigs(ListReportConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListReportConfigsResponse ListReportConfigs(ListReportConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ReportConfigs in a given project and location.

Parameters
NameDescription
requestListReportConfigsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
ListReportConfigsResponse

The response received from the server.

ListReportConfigsAsync(ListReportConfigsRequest, CallOptions)

public virtual AsyncUnaryCall<ListReportConfigsResponse> ListReportConfigsAsync(ListReportConfigsRequest request, CallOptions options)

Lists ReportConfigs in a given project and location.

Parameters
NameDescription
requestListReportConfigsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListReportConfigsResponse

The call object.

ListReportConfigsAsync(ListReportConfigsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListReportConfigsResponse> ListReportConfigsAsync(ListReportConfigsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ReportConfigs in a given project and location.

Parameters
NameDescription
requestListReportConfigsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallListReportConfigsResponse

The call object.

ListReportDetails(ListReportDetailsRequest, CallOptions)

public virtual ListReportDetailsResponse ListReportDetails(ListReportDetailsRequest request, CallOptions options)

Lists ReportDetails in a given project and location.

Parameters
NameDescription
requestListReportDetailsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListReportDetailsResponse

The response received from the server.

ListReportDetails(ListReportDetailsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListReportDetailsResponse ListReportDetails(ListReportDetailsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ReportDetails in a given project and location.

Parameters
NameDescription
requestListReportDetailsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
ListReportDetailsResponse

The response received from the server.

ListReportDetailsAsync(ListReportDetailsRequest, CallOptions)

public virtual AsyncUnaryCall<ListReportDetailsResponse> ListReportDetailsAsync(ListReportDetailsRequest request, CallOptions options)

Lists ReportDetails in a given project and location.

Parameters
NameDescription
requestListReportDetailsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListReportDetailsResponse

The call object.

ListReportDetailsAsync(ListReportDetailsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListReportDetailsResponse> ListReportDetailsAsync(ListReportDetailsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ReportDetails in a given project and location.

Parameters
NameDescription
requestListReportDetailsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallListReportDetailsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override StorageInsights.StorageInsightsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
StorageInsightsStorageInsightsClient
Overrides

UpdateReportConfig(UpdateReportConfigRequest, CallOptions)

public virtual ReportConfig UpdateReportConfig(UpdateReportConfigRequest request, CallOptions options)

Updates the parameters of a single ReportConfig.

Parameters
NameDescription
requestUpdateReportConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ReportConfig

The response received from the server.

UpdateReportConfig(UpdateReportConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual ReportConfig UpdateReportConfig(UpdateReportConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single ReportConfig.

Parameters
NameDescription
requestUpdateReportConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
ReportConfig

The response received from the server.

UpdateReportConfigAsync(UpdateReportConfigRequest, CallOptions)

public virtual AsyncUnaryCall<ReportConfig> UpdateReportConfigAsync(UpdateReportConfigRequest request, CallOptions options)

Updates the parameters of a single ReportConfig.

Parameters
NameDescription
requestUpdateReportConfigRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallReportConfig

The call object.

UpdateReportConfigAsync(UpdateReportConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReportConfig> UpdateReportConfigAsync(UpdateReportConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single ReportConfig.

Parameters
NameDescription
requestUpdateReportConfigRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallReportConfig

The call object.