Class ConfigServiceV2.ConfigServiceV2Client (3.6.0)

public class ConfigServiceV2Client : ClientBase<ConfigServiceV2.ConfigServiceV2Client>

Client for ConfigServiceV2

Inheritance

Object > ClientBase > ClientBase<ConfigServiceV2.ConfigServiceV2Client> > ConfigServiceV2.ConfigServiceV2Client

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

ConfigServiceV2Client()

protected ConfigServiceV2Client()

Protected parameterless constructor to allow creation of test doubles.

ConfigServiceV2Client(CallInvoker)

public ConfigServiceV2Client(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

ConfigServiceV2Client(Channel)

[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public ConfigServiceV2Client(Channel channel)

Creates a new client using a channel.

Parameter
NameDescription
channelGrpc.Core.Channel

The channel to use to make remote calls.

ConfigServiceV2Client(ChannelBase)

public ConfigServiceV2Client(ChannelBase channel)

Creates a new client for ConfigServiceV2

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

ConfigServiceV2Client(ClientBase.ClientBaseConfiguration)

protected ConfigServiceV2Client(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CopyLogEntries(CopyLogEntriesRequest, CallOptions)

public virtual Operation CopyLogEntries(CopyLogEntriesRequest request, CallOptions options)

Copies a set of log entries from a log bucket to a Cloud Storage bucket.

Parameters
NameDescription
requestCopyLogEntriesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CopyLogEntries(CopyLogEntriesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Copies a set of log entries from a log bucket to a Cloud Storage bucket.

Parameters
NameDescription
requestCopyLogEntriesRequest

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.

CopyLogEntriesAsync(CopyLogEntriesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CopyLogEntriesAsync(CopyLogEntriesRequest request, CallOptions options)

Copies a set of log entries from a log bucket to a Cloud Storage bucket.

Parameters
NameDescription
requestCopyLogEntriesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CopyLogEntriesAsync(CopyLogEntriesRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Copies a set of log entries from a log bucket to a Cloud Storage bucket.

Parameters
NameDescription
requestCopyLogEntriesRequest

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.

CreateBucket(CreateBucketRequest, CallOptions)

public virtual LogBucket CreateBucket(CreateBucketRequest request, CallOptions options)

Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.

Parameters
NameDescription
requestCreateBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogBucket

The response received from the server.

CreateBucket(CreateBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogBucket CreateBucket(CreateBucketRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.

Parameters
NameDescription
requestCreateBucketRequest

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
LogBucket

The response received from the server.

CreateBucketAsync(CreateBucketRequest, CallOptions)

public virtual AsyncUnaryCall<LogBucket> CreateBucketAsync(CreateBucketRequest request, CallOptions options)

Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.

Parameters
NameDescription
requestCreateBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogBucket>

The call object.

CreateBucketAsync(CreateBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogBucket> CreateBucketAsync(CreateBucketRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed.

Parameters
NameDescription
requestCreateBucketRequest

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<LogBucket>

The call object.

CreateExclusion(CreateExclusionRequest, CallOptions)

public virtual LogExclusion CreateExclusion(CreateExclusionRequest request, CallOptions options)

Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

Parameters
NameDescription
requestCreateExclusionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogExclusion

The response received from the server.

CreateExclusion(CreateExclusionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogExclusion CreateExclusion(CreateExclusionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

Parameters
NameDescription
requestCreateExclusionRequest

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
LogExclusion

The response received from the server.

CreateExclusionAsync(CreateExclusionRequest, CallOptions)

public virtual AsyncUnaryCall<LogExclusion> CreateExclusionAsync(CreateExclusionRequest request, CallOptions options)

Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

Parameters
NameDescription
requestCreateExclusionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogExclusion>

The call object.

CreateExclusionAsync(CreateExclusionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogExclusion> CreateExclusionAsync(CreateExclusionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.

Parameters
NameDescription
requestCreateExclusionRequest

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<LogExclusion>

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.

CreateSink(CreateSinkRequest, CallOptions)

public virtual LogSink CreateSink(CreateSinkRequest request, CallOptions options)

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

Parameters
NameDescription
requestCreateSinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogSink

The response received from the server.

CreateSink(CreateSinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogSink CreateSink(CreateSinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

Parameters
NameDescription
requestCreateSinkRequest

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
LogSink

The response received from the server.

CreateSinkAsync(CreateSinkRequest, CallOptions)

public virtual AsyncUnaryCall<LogSink> CreateSinkAsync(CreateSinkRequest request, CallOptions options)

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

Parameters
NameDescription
requestCreateSinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogSink>

The call object.

CreateSinkAsync(CreateSinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogSink> CreateSinkAsync(CreateSinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.

Parameters
NameDescription
requestCreateSinkRequest

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<LogSink>

The call object.

CreateView(CreateViewRequest, CallOptions)

public virtual LogView CreateView(CreateViewRequest request, CallOptions options)

Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

Parameters
NameDescription
requestCreateViewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogView

The response received from the server.

CreateView(CreateViewRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogView CreateView(CreateViewRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

Parameters
NameDescription
requestCreateViewRequest

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
LogView

The response received from the server.

CreateViewAsync(CreateViewRequest, CallOptions)

public virtual AsyncUnaryCall<LogView> CreateViewAsync(CreateViewRequest request, CallOptions options)

Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

Parameters
NameDescription
requestCreateViewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogView>

The call object.

CreateViewAsync(CreateViewRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogView> CreateViewAsync(CreateViewRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

Parameters
NameDescription
requestCreateViewRequest

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<LogView>

The call object.

DeleteBucket(DeleteBucketRequest, CallOptions)

public virtual Empty DeleteBucket(DeleteBucketRequest request, CallOptions options)

Deletes a log bucket.

Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.

Parameters
NameDescription
requestDeleteBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteBucket(DeleteBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a log bucket.

Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.

Parameters
NameDescription
requestDeleteBucketRequest

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
Empty

The response received from the server.

DeleteBucketAsync(DeleteBucketRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteBucketAsync(DeleteBucketRequest request, CallOptions options)

Deletes a log bucket.

Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.

Parameters
NameDescription
requestDeleteBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteBucketAsync(DeleteBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a log bucket.

Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted.

Parameters
NameDescription
requestDeleteBucketRequest

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<Empty>

The call object.

DeleteExclusion(DeleteExclusionRequest, CallOptions)

public virtual Empty DeleteExclusion(DeleteExclusionRequest request, CallOptions options)

Deletes an exclusion in the _Default sink.

Parameters
NameDescription
requestDeleteExclusionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteExclusion(DeleteExclusionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes an exclusion in the _Default sink.

Parameters
NameDescription
requestDeleteExclusionRequest

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
Empty

The response received from the server.

DeleteExclusionAsync(DeleteExclusionRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteExclusionAsync(DeleteExclusionRequest request, CallOptions options)

Deletes an exclusion in the _Default sink.

Parameters
NameDescription
requestDeleteExclusionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteExclusionAsync(DeleteExclusionRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes an exclusion in the _Default sink.

Parameters
NameDescription
requestDeleteExclusionRequest

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<Empty>

The call object.

DeleteSink(DeleteSinkRequest, CallOptions)

public virtual Empty DeleteSink(DeleteSinkRequest request, CallOptions options)

Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.

Parameters
NameDescription
requestDeleteSinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteSink(DeleteSinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.

Parameters
NameDescription
requestDeleteSinkRequest

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
Empty

The response received from the server.

DeleteSinkAsync(DeleteSinkRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteSinkAsync(DeleteSinkRequest request, CallOptions options)

Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.

Parameters
NameDescription
requestDeleteSinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteSinkAsync(DeleteSinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.

Parameters
NameDescription
requestDeleteSinkRequest

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<Empty>

The call object.

DeleteView(DeleteViewRequest, CallOptions)

public virtual Empty DeleteView(DeleteViewRequest request, CallOptions options)

Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.

Parameters
NameDescription
requestDeleteViewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteView(DeleteViewRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.

Parameters
NameDescription
requestDeleteViewRequest

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
Empty

The response received from the server.

DeleteViewAsync(DeleteViewRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteViewAsync(DeleteViewRequest request, CallOptions options)

Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.

Parameters
NameDescription
requestDeleteViewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

DeleteViewAsync(DeleteViewRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes.

Parameters
NameDescription
requestDeleteViewRequest

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<Empty>

The call object.

GetBucket(GetBucketRequest, CallOptions)

public virtual LogBucket GetBucket(GetBucketRequest request, CallOptions options)

Gets a log bucket.

Parameters
NameDescription
requestGetBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogBucket

The response received from the server.

GetBucket(GetBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogBucket GetBucket(GetBucketRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a log bucket.

Parameters
NameDescription
requestGetBucketRequest

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
LogBucket

The response received from the server.

GetBucketAsync(GetBucketRequest, CallOptions)

public virtual AsyncUnaryCall<LogBucket> GetBucketAsync(GetBucketRequest request, CallOptions options)

Gets a log bucket.

Parameters
NameDescription
requestGetBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogBucket>

The call object.

GetBucketAsync(GetBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogBucket> GetBucketAsync(GetBucketRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a log bucket.

Parameters
NameDescription
requestGetBucketRequest

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<LogBucket>

The call object.

GetCmekSettings(GetCmekSettingsRequest, CallOptions)

public virtual CmekSettings GetCmekSettings(GetCmekSettingsRequest request, CallOptions options)

Gets the Logging CMEK settings for the given resource.

Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestGetCmekSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
CmekSettings

The response received from the server.

GetCmekSettings(GetCmekSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual CmekSettings GetCmekSettings(GetCmekSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets the Logging CMEK settings for the given resource.

Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestGetCmekSettingsRequest

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
CmekSettings

The response received from the server.

GetCmekSettingsAsync(GetCmekSettingsRequest, CallOptions)

public virtual AsyncUnaryCall<CmekSettings> GetCmekSettingsAsync(GetCmekSettingsRequest request, CallOptions options)

Gets the Logging CMEK settings for the given resource.

Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestGetCmekSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<CmekSettings>

The call object.

GetCmekSettingsAsync(GetCmekSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<CmekSettings> GetCmekSettingsAsync(GetCmekSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets the Logging CMEK settings for the given resource.

Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestGetCmekSettingsRequest

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<CmekSettings>

The call object.

GetExclusion(GetExclusionRequest, CallOptions)

public virtual LogExclusion GetExclusion(GetExclusionRequest request, CallOptions options)

Gets the description of an exclusion in the _Default sink.

Parameters
NameDescription
requestGetExclusionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogExclusion

The response received from the server.

GetExclusion(GetExclusionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogExclusion GetExclusion(GetExclusionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets the description of an exclusion in the _Default sink.

Parameters
NameDescription
requestGetExclusionRequest

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
LogExclusion

The response received from the server.

GetExclusionAsync(GetExclusionRequest, CallOptions)

public virtual AsyncUnaryCall<LogExclusion> GetExclusionAsync(GetExclusionRequest request, CallOptions options)

Gets the description of an exclusion in the _Default sink.

Parameters
NameDescription
requestGetExclusionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogExclusion>

The call object.

GetExclusionAsync(GetExclusionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogExclusion> GetExclusionAsync(GetExclusionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets the description of an exclusion in the _Default sink.

Parameters
NameDescription
requestGetExclusionRequest

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<LogExclusion>

The call object.

GetSettings(GetSettingsRequest, CallOptions)

public virtual Settings GetSettings(GetSettingsRequest request, CallOptions options)

Gets the Log Router settings for the given resource.

Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestGetSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Settings

The response received from the server.

GetSettings(GetSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Settings GetSettings(GetSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets the Log Router settings for the given resource.

Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestGetSettingsRequest

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
Settings

The response received from the server.

GetSettingsAsync(GetSettingsRequest, CallOptions)

public virtual AsyncUnaryCall<Settings> GetSettingsAsync(GetSettingsRequest request, CallOptions options)

Gets the Log Router settings for the given resource.

Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestGetSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Settings>

The call object.

GetSettingsAsync(GetSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Settings> GetSettingsAsync(GetSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets the Log Router settings for the given resource.

Note: Settings for the Log Router can be get for Google Cloud projects, folders, organizations and billing accounts. Currently it can only be configured for organizations. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestGetSettingsRequest

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<Settings>

The call object.

GetSink(GetSinkRequest, CallOptions)

public virtual LogSink GetSink(GetSinkRequest request, CallOptions options)

Gets a sink.

Parameters
NameDescription
requestGetSinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogSink

The response received from the server.

GetSink(GetSinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogSink GetSink(GetSinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a sink.

Parameters
NameDescription
requestGetSinkRequest

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
LogSink

The response received from the server.

GetSinkAsync(GetSinkRequest, CallOptions)

public virtual AsyncUnaryCall<LogSink> GetSinkAsync(GetSinkRequest request, CallOptions options)

Gets a sink.

Parameters
NameDescription
requestGetSinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogSink>

The call object.

GetSinkAsync(GetSinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogSink> GetSinkAsync(GetSinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a sink.

Parameters
NameDescription
requestGetSinkRequest

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<LogSink>

The call object.

GetView(GetViewRequest, CallOptions)

public virtual LogView GetView(GetViewRequest request, CallOptions options)

Gets a view on a log bucket..

Parameters
NameDescription
requestGetViewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogView

The response received from the server.

GetView(GetViewRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogView GetView(GetViewRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a view on a log bucket..

Parameters
NameDescription
requestGetViewRequest

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
LogView

The response received from the server.

GetViewAsync(GetViewRequest, CallOptions)

public virtual AsyncUnaryCall<LogView> GetViewAsync(GetViewRequest request, CallOptions options)

Gets a view on a log bucket..

Parameters
NameDescription
requestGetViewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogView>

The call object.

GetViewAsync(GetViewRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogView> GetViewAsync(GetViewRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets a view on a log bucket..

Parameters
NameDescription
requestGetViewRequest

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<LogView>

The call object.

ListBuckets(ListBucketsRequest, CallOptions)

public virtual ListBucketsResponse ListBuckets(ListBucketsRequest request, CallOptions options)

Lists log buckets.

Parameters
NameDescription
requestListBucketsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListBucketsResponse

The response received from the server.

ListBuckets(ListBucketsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListBucketsResponse ListBuckets(ListBucketsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists log buckets.

Parameters
NameDescription
requestListBucketsRequest

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
ListBucketsResponse

The response received from the server.

ListBucketsAsync(ListBucketsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBucketsResponse> ListBucketsAsync(ListBucketsRequest request, CallOptions options)

Lists log buckets.

Parameters
NameDescription
requestListBucketsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListBucketsResponse>

The call object.

ListBucketsAsync(ListBucketsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListBucketsResponse> ListBucketsAsync(ListBucketsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists log buckets.

Parameters
NameDescription
requestListBucketsRequest

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<ListBucketsResponse>

The call object.

ListExclusions(ListExclusionsRequest, CallOptions)

public virtual ListExclusionsResponse ListExclusions(ListExclusionsRequest request, CallOptions options)

Lists all the exclusions on the _Default sink in a parent resource.

Parameters
NameDescription
requestListExclusionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListExclusionsResponse

The response received from the server.

ListExclusions(ListExclusionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListExclusionsResponse ListExclusions(ListExclusionsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists all the exclusions on the _Default sink in a parent resource.

Parameters
NameDescription
requestListExclusionsRequest

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
ListExclusionsResponse

The response received from the server.

ListExclusionsAsync(ListExclusionsRequest, CallOptions)

public virtual AsyncUnaryCall<ListExclusionsResponse> ListExclusionsAsync(ListExclusionsRequest request, CallOptions options)

Lists all the exclusions on the _Default sink in a parent resource.

Parameters
NameDescription
requestListExclusionsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListExclusionsResponse>

The call object.

ListExclusionsAsync(ListExclusionsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListExclusionsResponse> ListExclusionsAsync(ListExclusionsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists all the exclusions on the _Default sink in a parent resource.

Parameters
NameDescription
requestListExclusionsRequest

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<ListExclusionsResponse>

The call object.

ListSinks(ListSinksRequest, CallOptions)

public virtual ListSinksResponse ListSinks(ListSinksRequest request, CallOptions options)

Lists sinks.

Parameters
NameDescription
requestListSinksRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListSinksResponse

The response received from the server.

ListSinks(ListSinksRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListSinksResponse ListSinks(ListSinksRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists sinks.

Parameters
NameDescription
requestListSinksRequest

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
ListSinksResponse

The response received from the server.

ListSinksAsync(ListSinksRequest, CallOptions)

public virtual AsyncUnaryCall<ListSinksResponse> ListSinksAsync(ListSinksRequest request, CallOptions options)

Lists sinks.

Parameters
NameDescription
requestListSinksRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListSinksResponse>

The call object.

ListSinksAsync(ListSinksRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListSinksResponse> ListSinksAsync(ListSinksRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists sinks.

Parameters
NameDescription
requestListSinksRequest

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<ListSinksResponse>

The call object.

ListViews(ListViewsRequest, CallOptions)

public virtual ListViewsResponse ListViews(ListViewsRequest request, CallOptions options)

Lists views on a log bucket.

Parameters
NameDescription
requestListViewsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListViewsResponse

The response received from the server.

ListViews(ListViewsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListViewsResponse ListViews(ListViewsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists views on a log bucket.

Parameters
NameDescription
requestListViewsRequest

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
ListViewsResponse

The response received from the server.

ListViewsAsync(ListViewsRequest, CallOptions)

public virtual AsyncUnaryCall<ListViewsResponse> ListViewsAsync(ListViewsRequest request, CallOptions options)

Lists views on a log bucket.

Parameters
NameDescription
requestListViewsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListViewsResponse>

The call object.

ListViewsAsync(ListViewsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListViewsResponse> ListViewsAsync(ListViewsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists views on a log bucket.

Parameters
NameDescription
requestListViewsRequest

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<ListViewsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override ConfigServiceV2.ConfigServiceV2Client NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
ConfigServiceV2.ConfigServiceV2Client
Overrides
Grpc.Core.ClientBase<Google.Cloud.Logging.V2.ConfigServiceV2.ConfigServiceV2Client>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UndeleteBucket(UndeleteBucketRequest, CallOptions)

public virtual Empty UndeleteBucket(UndeleteBucketRequest request, CallOptions options)

Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.

Parameters
NameDescription
requestUndeleteBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

UndeleteBucket(UndeleteBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.

Parameters
NameDescription
requestUndeleteBucketRequest

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
Empty

The response received from the server.

UndeleteBucketAsync(UndeleteBucketRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> UndeleteBucketAsync(UndeleteBucketRequest request, CallOptions options)

Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.

Parameters
NameDescription
requestUndeleteBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Empty>

The call object.

UndeleteBucketAsync(UndeleteBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.

Parameters
NameDescription
requestUndeleteBucketRequest

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<Empty>

The call object.

UpdateBucket(UpdateBucketRequest, CallOptions)

public virtual LogBucket UpdateBucket(UpdateBucketRequest request, CallOptions options)

Updates a log bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_period

If the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.

If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.

After a bucket has been created, the bucket's location cannot be changed.

Parameters
NameDescription
requestUpdateBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogBucket

The response received from the server.

UpdateBucket(UpdateBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogBucket UpdateBucket(UpdateBucketRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a log bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_period

If the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.

If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.

After a bucket has been created, the bucket's location cannot be changed.

Parameters
NameDescription
requestUpdateBucketRequest

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
LogBucket

The response received from the server.

UpdateBucketAsync(UpdateBucketRequest, CallOptions)

public virtual AsyncUnaryCall<LogBucket> UpdateBucketAsync(UpdateBucketRequest request, CallOptions options)

Updates a log bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_period

If the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.

If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.

After a bucket has been created, the bucket's location cannot be changed.

Parameters
NameDescription
requestUpdateBucketRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogBucket>

The call object.

UpdateBucketAsync(UpdateBucketRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogBucket> UpdateBucketAsync(UpdateBucketRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a log bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_period

If the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.

If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.

After a bucket has been created, the bucket's location cannot be changed.

Parameters
NameDescription
requestUpdateBucketRequest

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<LogBucket>

The call object.

UpdateCmekSettings(UpdateCmekSettingsRequest, CallOptions)

public virtual CmekSettings UpdateCmekSettings(UpdateCmekSettingsRequest request, CallOptions options)

Updates the Log Router CMEK settings for the given resource.

Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings] will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestUpdateCmekSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
CmekSettings

The response received from the server.

UpdateCmekSettings(UpdateCmekSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual CmekSettings UpdateCmekSettings(UpdateCmekSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the Log Router CMEK settings for the given resource.

Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings] will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestUpdateCmekSettingsRequest

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
CmekSettings

The response received from the server.

UpdateCmekSettingsAsync(UpdateCmekSettingsRequest, CallOptions)

public virtual AsyncUnaryCall<CmekSettings> UpdateCmekSettingsAsync(UpdateCmekSettingsRequest request, CallOptions options)

Updates the Log Router CMEK settings for the given resource.

Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings] will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestUpdateCmekSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<CmekSettings>

The call object.

UpdateCmekSettingsAsync(UpdateCmekSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<CmekSettings> UpdateCmekSettingsAsync(UpdateCmekSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the Log Router CMEK settings for the given resource.

Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateCmekSettings][google.logging.v2.ConfigServiceV2.UpdateCmekSettings] will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestUpdateCmekSettingsRequest

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<CmekSettings>

The call object.

UpdateExclusion(UpdateExclusionRequest, CallOptions)

public virtual LogExclusion UpdateExclusion(UpdateExclusionRequest request, CallOptions options)

Changes one or more properties of an existing exclusion in the _Default sink.

Parameters
NameDescription
requestUpdateExclusionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogExclusion

The response received from the server.

UpdateExclusion(UpdateExclusionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogExclusion UpdateExclusion(UpdateExclusionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Changes one or more properties of an existing exclusion in the _Default sink.

Parameters
NameDescription
requestUpdateExclusionRequest

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
LogExclusion

The response received from the server.

UpdateExclusionAsync(UpdateExclusionRequest, CallOptions)

public virtual AsyncUnaryCall<LogExclusion> UpdateExclusionAsync(UpdateExclusionRequest request, CallOptions options)

Changes one or more properties of an existing exclusion in the _Default sink.

Parameters
NameDescription
requestUpdateExclusionRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogExclusion>

The call object.

UpdateExclusionAsync(UpdateExclusionRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogExclusion> UpdateExclusionAsync(UpdateExclusionRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Changes one or more properties of an existing exclusion in the _Default sink.

Parameters
NameDescription
requestUpdateExclusionRequest

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<LogExclusion>

The call object.

UpdateSettings(UpdateSettingsRequest, CallOptions)

public virtual Settings UpdateSettings(UpdateSettingsRequest request, CallOptions options)

Updates the Log Router settings for the given resource.

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings] will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled. 4) location_id is not supported by Logging. 5) location_id violate OrgPolicy.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestUpdateSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Settings

The response received from the server.

UpdateSettings(UpdateSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Settings UpdateSettings(UpdateSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the Log Router settings for the given resource.

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings] will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled. 4) location_id is not supported by Logging. 5) location_id violate OrgPolicy.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestUpdateSettingsRequest

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
Settings

The response received from the server.

UpdateSettingsAsync(UpdateSettingsRequest, CallOptions)

public virtual AsyncUnaryCall<Settings> UpdateSettingsAsync(UpdateSettingsRequest request, CallOptions options)

Updates the Log Router settings for the given resource.

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings] will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled. 4) location_id is not supported by Logging. 5) location_id violate OrgPolicy.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestUpdateSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Settings>

The call object.

UpdateSettingsAsync(UpdateSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Settings> UpdateSettingsAsync(UpdateSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the Log Router settings for the given resource.

Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.

[UpdateSettings][google.logging.v2.ConfigServiceV2.UpdateSettings] will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled. 4) location_id is not supported by Logging. 5) location_id violate OrgPolicy.

See Enabling CMEK for Log Router for more information.

Parameters
NameDescription
requestUpdateSettingsRequest

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<Settings>

The call object.

UpdateSink(UpdateSinkRequest, CallOptions)

public virtual LogSink UpdateSink(UpdateSinkRequest request, CallOptions options)

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.

The updated sink might also have a new writer_identity; see the unique_writer_identity field.

Parameters
NameDescription
requestUpdateSinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogSink

The response received from the server.

UpdateSink(UpdateSinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogSink UpdateSink(UpdateSinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.

The updated sink might also have a new writer_identity; see the unique_writer_identity field.

Parameters
NameDescription
requestUpdateSinkRequest

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
LogSink

The response received from the server.

UpdateSinkAsync(UpdateSinkRequest, CallOptions)

public virtual AsyncUnaryCall<LogSink> UpdateSinkAsync(UpdateSinkRequest request, CallOptions options)

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.

The updated sink might also have a new writer_identity; see the unique_writer_identity field.

Parameters
NameDescription
requestUpdateSinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogSink>

The call object.

UpdateSinkAsync(UpdateSinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogSink> UpdateSinkAsync(UpdateSinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter.

The updated sink might also have a new writer_identity; see the unique_writer_identity field.

Parameters
NameDescription
requestUpdateSinkRequest

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<LogSink>

The call object.

UpdateView(UpdateViewRequest, CallOptions)

public virtual LogView UpdateView(UpdateViewRequest request, CallOptions options)

Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.

Parameters
NameDescription
requestUpdateViewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
LogView

The response received from the server.

UpdateView(UpdateViewRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual LogView UpdateView(UpdateViewRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.

Parameters
NameDescription
requestUpdateViewRequest

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
LogView

The response received from the server.

UpdateViewAsync(UpdateViewRequest, CallOptions)

public virtual AsyncUnaryCall<LogView> UpdateViewAsync(UpdateViewRequest request, CallOptions options)

Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.

Parameters
NameDescription
requestUpdateViewRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<LogView>

The call object.

UpdateViewAsync(UpdateViewRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<LogView> UpdateViewAsync(UpdateViewRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a view on a log bucket. This method replaces the following fields in the existing view with values from the new view: filter. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes.

Parameters
NameDescription
requestUpdateViewRequest

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<LogView>

The call object.