Class ConfigServiceV2.ConfigServiceV2Base (3.3.0)

[BindServiceMethod(typeof(ConfigServiceV2), "BindService")]
public abstract class ConfigServiceV2Base

Base class for server-side implementations of ConfigServiceV2

Inheritance

Object > ConfigServiceV2.ConfigServiceV2Base

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Methods

CreateBucket(CreateBucketRequest, ServerCallContext)

public virtual Task<LogBucket> CreateBucket(CreateBucketRequest request, ServerCallContext context)

Creates a bucket that can be used to store log entries. Once a bucket has been created, the region cannot be changed.

Parameters
Name	Description
`request`	`CreateBucketRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogBucket>`	The response to send back to the client (wrapped by a task).

CreateExclusion(CreateExclusionRequest, ServerCallContext)

public virtual Task<LogExclusion> CreateExclusion(CreateExclusionRequest request, ServerCallContext context)

Creates a new exclusion 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
Name	Description
`request`	`CreateExclusionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogExclusion>`	The response to send back to the client (wrapped by a task).

CreateSink(CreateSinkRequest, ServerCallContext)

public virtual Task<LogSink> CreateSink(CreateSinkRequest request, ServerCallContext context)

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
Name	Description
`request`	`CreateSinkRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogSink>`	The response to send back to the client (wrapped by a task).

CreateView(CreateViewRequest, ServerCallContext)

public virtual Task<LogView> CreateView(CreateViewRequest request, ServerCallContext context)

Creates a view over logs in a bucket. A bucket may contain a maximum of 50 views.

Parameters
Name	Description
`request`	`CreateViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogView>`	The response to send back to the client (wrapped by a task).

DeleteBucket(DeleteBucketRequest, ServerCallContext)

public virtual Task<Empty> DeleteBucket(DeleteBucketRequest request, ServerCallContext context)

Deletes a bucket. Moves the bucket to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all logs in the bucket will be permanently deleted.

Parameters
Name	Description
`request`	`DeleteBucketRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Empty>`	The response to send back to the client (wrapped by a task).

DeleteExclusion(DeleteExclusionRequest, ServerCallContext)

public virtual Task<Empty> DeleteExclusion(DeleteExclusionRequest request, ServerCallContext context)

Deletes an exclusion.

Parameters
Name	Description
`request`	`DeleteExclusionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Empty>`	The response to send back to the client (wrapped by a task).

DeleteSink(DeleteSinkRequest, ServerCallContext)

public virtual Task<Empty> DeleteSink(DeleteSinkRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`DeleteSinkRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Empty>`	The response to send back to the client (wrapped by a task).

DeleteView(DeleteViewRequest, ServerCallContext)

public virtual Task<Empty> DeleteView(DeleteViewRequest request, ServerCallContext context)

Deletes a view from a bucket.

Parameters
Name	Description
`request`	`DeleteViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Empty>`	The response to send back to the client (wrapped by a task).

GetBucket(GetBucketRequest, ServerCallContext)

public virtual Task<LogBucket> GetBucket(GetBucketRequest request, ServerCallContext context)

Gets a bucket.

Parameters
Name	Description
`request`	`GetBucketRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogBucket>`	The response to send back to the client (wrapped by a task).

GetCmekSettings(GetCmekSettingsRequest, ServerCallContext)

public virtual Task<CmekSettings> GetCmekSettings(GetCmekSettingsRequest request, ServerCallContext context)

Gets the Logs Router CMEK settings for the given resource.

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

See Enabling CMEK for Logs Router for more information.

Parameters
Name	Description
`request`	`GetCmekSettingsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<CmekSettings>`	The response to send back to the client (wrapped by a task).

GetExclusion(GetExclusionRequest, ServerCallContext)

public virtual Task<LogExclusion> GetExclusion(GetExclusionRequest request, ServerCallContext context)

Gets the description of an exclusion.

Parameters
Name	Description
`request`	`GetExclusionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogExclusion>`	The response to send back to the client (wrapped by a task).

GetSink(GetSinkRequest, ServerCallContext)

public virtual Task<LogSink> GetSink(GetSinkRequest request, ServerCallContext context)

Gets a sink.

Parameters
Name	Description
`request`	`GetSinkRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogSink>`	The response to send back to the client (wrapped by a task).

GetView(GetViewRequest, ServerCallContext)

public virtual Task<LogView> GetView(GetViewRequest request, ServerCallContext context)

Gets a view.

Parameters
Name	Description
`request`	`GetViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogView>`	The response to send back to the client (wrapped by a task).

ListBuckets(ListBucketsRequest, ServerCallContext)

public virtual Task<ListBucketsResponse> ListBuckets(ListBucketsRequest request, ServerCallContext context)

Lists buckets.

Parameters
Name	Description
`request`	`ListBucketsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListBucketsResponse>`	The response to send back to the client (wrapped by a task).

ListExclusions(ListExclusionsRequest, ServerCallContext)

public virtual Task<ListExclusionsResponse> ListExclusions(ListExclusionsRequest request, ServerCallContext context)

Lists all the exclusions in a parent resource.

Parameters
Name	Description
`request`	`ListExclusionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListExclusionsResponse>`	The response to send back to the client (wrapped by a task).

ListSinks(ListSinksRequest, ServerCallContext)

public virtual Task<ListSinksResponse> ListSinks(ListSinksRequest request, ServerCallContext context)

Lists sinks.

Parameters
Name	Description
`request`	`ListSinksRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListSinksResponse>`	The response to send back to the client (wrapped by a task).

ListViews(ListViewsRequest, ServerCallContext)

public virtual Task<ListViewsResponse> ListViews(ListViewsRequest request, ServerCallContext context)

Lists views on a bucket.

Parameters
Name	Description
`request`	`ListViewsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<ListViewsResponse>`	The response to send back to the client (wrapped by a task).

UndeleteBucket(UndeleteBucketRequest, ServerCallContext)

public virtual Task<Empty> UndeleteBucket(UndeleteBucketRequest request, ServerCallContext context)

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

Parameters
Name	Description
`request`	`UndeleteBucketRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<Empty>`	The response to send back to the client (wrapped by a task).

UpdateBucket(UpdateBucketRequest, ServerCallContext)

public virtual Task<LogBucket> UpdateBucket(UpdateBucketRequest request, ServerCallContext context)

Updates a 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 LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.

A buckets region may not be modified after it is created.

Parameters
Name	Description
`request`	`UpdateBucketRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogBucket>`	The response to send back to the client (wrapped by a task).

UpdateCmekSettings(UpdateCmekSettingsRequest, ServerCallContext)

public virtual Task<CmekSettings> UpdateCmekSettings(UpdateCmekSettingsRequest request, ServerCallContext context)

Updates the Logs Router CMEK settings for the given resource.

Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP 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 Logs Router for more information.

Parameters
Name	Description
`request`	`UpdateCmekSettingsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<CmekSettings>`	The response to send back to the client (wrapped by a task).

UpdateExclusion(UpdateExclusionRequest, ServerCallContext)

public virtual Task<LogExclusion> UpdateExclusion(UpdateExclusionRequest request, ServerCallContext context)

Changes one or more properties of an existing exclusion.

Parameters
Name	Description
`request`	`UpdateExclusionRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogExclusion>`	The response to send back to the client (wrapped by a task).

UpdateSink(UpdateSinkRequest, ServerCallContext)

public virtual Task<LogSink> UpdateSink(UpdateSinkRequest request, ServerCallContext context)

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
Name	Description
`request`	`UpdateSinkRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogSink>`	The response to send back to the client (wrapped by a task).

UpdateView(UpdateViewRequest, ServerCallContext)

public virtual Task<LogView> UpdateView(UpdateViewRequest request, ServerCallContext context)

Updates a view. This method replaces the following fields in the existing view with values from the new view: filter.

Parameters
Name	Description
`request`	`UpdateViewRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`Task<LogView>`	The response to send back to the client (wrapped by a task).