Google Cloud Logging v2 API - Class ConfigServiceV2.ConfigServiceV2Base (4.4.0)

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

Reference documentation and code samples for the Google Cloud Logging v2 API class ConfigServiceV2.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

CopyLogEntries(CopyLogEntriesRequest, ServerCallContext)

public virtual Task<Operation> CopyLogEntries(CopyLogEntriesRequest request, ServerCallContext context)

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

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

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateBucket(CreateBucketRequest, ServerCallContext)

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

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
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
`TaskLogBucket`	The response to send back to the client (wrapped by a task).

CreateBucketLongRunning(CreateBucketRequest, ServerCallContext)

public virtual Task<Operation> CreateBucketLongRunning(CreateBucketRequest request, ServerCallContext context)

Creates a log bucket asynchronously that can be used to store log entries.

After a bucket has been created, the bucket's location 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
`TaskOperation`	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 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
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
`TaskLogExclusion`	The response to send back to the client (wrapped by a task).

CreateLink(CreateLinkRequest, ServerCallContext)

public virtual Task<Operation> CreateLink(CreateLinkRequest request, ServerCallContext context)

Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.

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

Returns
Type	Description
`TaskOperation`	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
`TaskLogSink`	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 log entries in a log bucket. A bucket may contain a maximum of 30 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
`TaskLogView`	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 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
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
`TaskEmpty`	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 in the _Default sink.

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
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteLink(DeleteLinkRequest, ServerCallContext)

public virtual Task<Operation> DeleteLink(DeleteLinkRequest request, ServerCallContext context)

Deletes a link. This will also delete the corresponding BigQuery linked dataset.

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

Returns
Type	Description
`TaskOperation`	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
`TaskEmpty`	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 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
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
`TaskEmpty`	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 log 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
`TaskLogBucket`	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 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
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
`TaskCmekSettings`	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 in the _Default sink.

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
`TaskLogExclusion`	The response to send back to the client (wrapped by a task).

GetLink(GetLinkRequest, ServerCallContext)

public virtual Task<Link> GetLink(GetLinkRequest request, ServerCallContext context)

Gets a link.

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

Returns
Type	Description
`TaskLink`	The response to send back to the client (wrapped by a task).

GetSettings(GetSettingsRequest, ServerCallContext)

public virtual Task<Settings> GetSettings(GetSettingsRequest request, ServerCallContext context)

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

Returns
Type	Description
`TaskSettings`	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
`TaskLogSink`	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 on a log bucket..

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
`TaskLogView`	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 log 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
`TaskListBucketsResponse`	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 on the _Default sink 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
`TaskListExclusionsResponse`	The response to send back to the client (wrapped by a task).

ListLinks(ListLinksRequest, ServerCallContext)

public virtual Task<ListLinksResponse> ListLinks(ListLinksRequest request, ServerCallContext context)

Lists links.

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

Returns
Type	Description
`TaskListLinksResponse`	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
`TaskListSinksResponse`	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 log 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
`TaskListViewsResponse`	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 log bucket. A bucket that has been deleted can 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
`TaskEmpty`	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 log bucket.

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
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
`TaskLogBucket`	The response to send back to the client (wrapped by a task).

UpdateBucketLongRunning(UpdateBucketRequest, ServerCallContext)

public virtual Task<Operation> UpdateBucketLongRunning(UpdateBucketRequest request, ServerCallContext context)

Updates a log bucket asynchronously.

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
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
`TaskOperation`	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 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
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
`TaskCmekSettings`	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 in the _Default sink.

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
`TaskLogExclusion`	The response to send back to the client (wrapped by a task).

UpdateSettings(UpdateSettingsRequest, ServerCallContext)

public virtual Task<Settings> UpdateSettings(UpdateSettingsRequest request, ServerCallContext context)

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

Returns
Type	Description
`TaskSettings`	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
`TaskLogSink`	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 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
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
`TaskLogView`	The response to send back to the client (wrapped by a task).