public sealed class ConfigServiceV2ClientImpl : ConfigServiceV2ClientReference documentation and code samples for the Google Cloud Logging v2 API class ConfigServiceV2ClientImpl.
ConfigServiceV2 client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Logging.V2Assembly
Google.Cloud.Logging.V2.dll
Remarks
Service for configuring sinks used to route log entries.
Constructors
ConfigServiceV2ClientImpl(ConfigServiceV2Client, ConfigServiceV2Settings, ILogger)
public ConfigServiceV2ClientImpl(ConfigServiceV2.ConfigServiceV2Client grpcClient, ConfigServiceV2Settings settings, ILogger logger)Constructs a client wrapper for the ConfigServiceV2 service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | ConfigServiceV2ConfigServiceV2ClientThe underlying gRPC client. |
settings | ConfigServiceV2SettingsThe base ConfigServiceV2Settings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
CopyLogEntriesOperationsClient
public override OperationsClient CopyLogEntriesOperationsClient { get; }The long-running operations client for CopyLogEntries.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateBucketLongRunningOperationsClient
public override OperationsClient CreateBucketLongRunningOperationsClient { get; }The long-running operations client for CreateBucketLongRunning.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateLinkOperationsClient
public override OperationsClient CreateLinkOperationsClient { get; }The long-running operations client for CreateLink.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteLinkOperationsClient
public override OperationsClient DeleteLinkOperationsClient { get; }The long-running operations client for DeleteLink.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override ConfigServiceV2.ConfigServiceV2Client GrpcClient { get; }The underlying gRPC ConfigServiceV2 client
| Property Value | |
|---|---|
| Type | Description |
ConfigServiceV2ConfigServiceV2Client | |
UpdateBucketLongRunningOperationsClient
public override OperationsClient UpdateBucketLongRunningOperationsClient { get; }The long-running operations client for UpdateBucketLongRunning.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
CopyLogEntries(CopyLogEntriesRequest, CallSettings)
public override Operation<CopyLogEntriesResponse, CopyLogEntriesMetadata> CopyLogEntries(CopyLogEntriesRequest request, CallSettings callSettings = null)Copies a set of log entries from a log bucket to a Cloud Storage bucket.
| Parameters | |
|---|---|
| Name | Description |
request | CopyLogEntriesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationCopyLogEntriesResponseCopyLogEntriesMetadata | The RPC response. |
CopyLogEntriesAsync(CopyLogEntriesRequest, CallSettings)
public override Task<Operation<CopyLogEntriesResponse, CopyLogEntriesMetadata>> CopyLogEntriesAsync(CopyLogEntriesRequest request, CallSettings callSettings = null)Copies a set of log entries from a log bucket to a Cloud Storage bucket.
| Parameters | |
|---|---|
| Name | Description |
request | CopyLogEntriesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationCopyLogEntriesResponseCopyLogEntriesMetadata | A Task containing the RPC response. |
CreateBucket(CreateBucketRequest, CallSettings)
public override LogBucket CreateBucket(CreateBucketRequest request, CallSettings callSettings = null)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 | CreateBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogBucket | The RPC response. |
CreateBucketAsync(CreateBucketRequest, CallSettings)
public override Task<LogBucket> CreateBucketAsync(CreateBucketRequest request, CallSettings callSettings = null)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 | CreateBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogBucket | A Task containing the RPC response. |
CreateBucketLongRunning(CreateBucketRequest, CallSettings)
public override Operation<LogBucket, BucketMetadata> CreateBucketLongRunning(CreateBucketRequest request, CallSettings callSettings = null)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 | CreateBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationLogBucketBucketMetadata | The RPC response. |
CreateBucketLongRunningAsync(CreateBucketRequest, CallSettings)
public override Task<Operation<LogBucket, BucketMetadata>> CreateBucketLongRunningAsync(CreateBucketRequest request, CallSettings callSettings = null)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 | CreateBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationLogBucketBucketMetadata | A Task containing the RPC response. |
CreateExclusion(CreateExclusionRequest, CallSettings)
public override LogExclusion CreateExclusion(CreateExclusionRequest request, CallSettings callSettings = null)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 | CreateExclusionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogExclusion | The RPC response. |
CreateExclusionAsync(CreateExclusionRequest, CallSettings)
public override Task<LogExclusion> CreateExclusionAsync(CreateExclusionRequest request, CallSettings callSettings = null)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 | CreateExclusionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogExclusion | A Task containing the RPC response. |
CreateLink(CreateLinkRequest, CallSettings)
public override Operation<Link, LinkMetadata> CreateLink(CreateLinkRequest request, CallSettings callSettings = null)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 | CreateLinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationLinkLinkMetadata | The RPC response. |
CreateLinkAsync(CreateLinkRequest, CallSettings)
public override Task<Operation<Link, LinkMetadata>> CreateLinkAsync(CreateLinkRequest request, CallSettings callSettings = null)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 | CreateLinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationLinkLinkMetadata | A Task containing the RPC response. |
CreateSink(CreateSinkRequest, CallSettings)
public override LogSink CreateSink(CreateSinkRequest request, CallSettings callSettings = null)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 | CreateSinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogSink | The RPC response. |
CreateSinkAsync(CreateSinkRequest, CallSettings)
public override Task<LogSink> CreateSinkAsync(CreateSinkRequest request, CallSettings callSettings = null)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 | CreateSinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogSink | A Task containing the RPC response. |
CreateView(CreateViewRequest, CallSettings)
public override LogView CreateView(CreateViewRequest request, CallSettings callSettings = null)Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.
| Parameters | |
|---|---|
| Name | Description |
request | CreateViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogView | The RPC response. |
CreateViewAsync(CreateViewRequest, CallSettings)
public override Task<LogView> CreateViewAsync(CreateViewRequest request, CallSettings callSettings = null)Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.
| Parameters | |
|---|---|
| Name | Description |
request | CreateViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogView | A Task containing the RPC response. |
DeleteBucket(DeleteBucketRequest, CallSettings)
public override void DeleteBucket(DeleteBucketRequest request, CallSettings callSettings = null)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 | DeleteBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteBucketAsync(DeleteBucketRequest, CallSettings)
public override Task DeleteBucketAsync(DeleteBucketRequest request, CallSettings callSettings = null)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 | DeleteBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DeleteExclusion(DeleteExclusionRequest, CallSettings)
public override void DeleteExclusion(DeleteExclusionRequest request, CallSettings callSettings = null)Deletes an exclusion in the _Default sink.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteExclusionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteExclusionAsync(DeleteExclusionRequest, CallSettings)
public override Task DeleteExclusionAsync(DeleteExclusionRequest request, CallSettings callSettings = null)Deletes an exclusion in the _Default sink.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteExclusionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DeleteLink(DeleteLinkRequest, CallSettings)
public override Operation<Empty, LinkMetadata> DeleteLink(DeleteLinkRequest request, CallSettings callSettings = null)Deletes a link. This will also delete the corresponding BigQuery linked dataset.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteLinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyLinkMetadata | The RPC response. |
DeleteLinkAsync(DeleteLinkRequest, CallSettings)
public override Task<Operation<Empty, LinkMetadata>> DeleteLinkAsync(DeleteLinkRequest request, CallSettings callSettings = null)Deletes a link. This will also delete the corresponding BigQuery linked dataset.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteLinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyLinkMetadata | A Task containing the RPC response. |
DeleteSink(DeleteSinkRequest, CallSettings)
public override void DeleteSink(DeleteSinkRequest request, CallSettings callSettings = null)Deletes a sink. If the sink has a unique writer_identity, then that
service account is also deleted.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteSinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteSinkAsync(DeleteSinkRequest, CallSettings)
public override Task DeleteSinkAsync(DeleteSinkRequest request, CallSettings callSettings = null)Deletes a sink. If the sink has a unique writer_identity, then that
service account is also deleted.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteSinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DeleteView(DeleteViewRequest, CallSettings)
public override void DeleteView(DeleteViewRequest request, CallSettings callSettings = null)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 | DeleteViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteViewAsync(DeleteViewRequest, CallSettings)
public override Task DeleteViewAsync(DeleteViewRequest request, CallSettings callSettings = null)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 | DeleteViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
GetBucket(GetBucketRequest, CallSettings)
public override LogBucket GetBucket(GetBucketRequest request, CallSettings callSettings = null)Gets a log bucket.
| Parameters | |
|---|---|
| Name | Description |
request | GetBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogBucket | The RPC response. |
GetBucketAsync(GetBucketRequest, CallSettings)
public override Task<LogBucket> GetBucketAsync(GetBucketRequest request, CallSettings callSettings = null)Gets a log bucket.
| Parameters | |
|---|---|
| Name | Description |
request | GetBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogBucket | A Task containing the RPC response. |
GetCmekSettings(GetCmekSettingsRequest, CallSettings)
public override CmekSettings GetCmekSettings(GetCmekSettingsRequest request, CallSettings callSettings = null)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 | GetCmekSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CmekSettings | The RPC response. |
GetCmekSettingsAsync(GetCmekSettingsRequest, CallSettings)
public override Task<CmekSettings> GetCmekSettingsAsync(GetCmekSettingsRequest request, CallSettings callSettings = null)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 | GetCmekSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCmekSettings | A Task containing the RPC response. |
GetExclusion(GetExclusionRequest, CallSettings)
public override LogExclusion GetExclusion(GetExclusionRequest request, CallSettings callSettings = null)Gets the description of an exclusion in the _Default sink.
| Parameters | |
|---|---|
| Name | Description |
request | GetExclusionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogExclusion | The RPC response. |
GetExclusionAsync(GetExclusionRequest, CallSettings)
public override Task<LogExclusion> GetExclusionAsync(GetExclusionRequest request, CallSettings callSettings = null)Gets the description of an exclusion in the _Default sink.
| Parameters | |
|---|---|
| Name | Description |
request | GetExclusionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogExclusion | A Task containing the RPC response. |
GetLink(GetLinkRequest, CallSettings)
public override Link GetLink(GetLinkRequest request, CallSettings callSettings = null)Gets a link.
| Parameters | |
|---|---|
| Name | Description |
request | GetLinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Link | The RPC response. |
GetLinkAsync(GetLinkRequest, CallSettings)
public override Task<Link> GetLinkAsync(GetLinkRequest request, CallSettings callSettings = null)Gets a link.
| Parameters | |
|---|---|
| Name | Description |
request | GetLinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLink | A Task containing the RPC response. |
GetSettings(GetSettingsRequest, CallSettings)
public override Settings GetSettings(GetSettingsRequest request, CallSettings callSettings = null)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 | GetSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Settings | The RPC response. |
GetSettingsAsync(GetSettingsRequest, CallSettings)
public override Task<Settings> GetSettingsAsync(GetSettingsRequest request, CallSettings callSettings = null)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 | GetSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSettings | A Task containing the RPC response. |
GetSink(GetSinkRequest, CallSettings)
public override LogSink GetSink(GetSinkRequest request, CallSettings callSettings = null)Gets a sink.
| Parameters | |
|---|---|
| Name | Description |
request | GetSinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogSink | The RPC response. |
GetSinkAsync(GetSinkRequest, CallSettings)
public override Task<LogSink> GetSinkAsync(GetSinkRequest request, CallSettings callSettings = null)Gets a sink.
| Parameters | |
|---|---|
| Name | Description |
request | GetSinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogSink | A Task containing the RPC response. |
GetView(GetViewRequest, CallSettings)
public override LogView GetView(GetViewRequest request, CallSettings callSettings = null)Gets a view on a log bucket..
| Parameters | |
|---|---|
| Name | Description |
request | GetViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogView | The RPC response. |
GetViewAsync(GetViewRequest, CallSettings)
public override Task<LogView> GetViewAsync(GetViewRequest request, CallSettings callSettings = null)Gets a view on a log bucket..
| Parameters | |
|---|---|
| Name | Description |
request | GetViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogView | A Task containing the RPC response. |
ListBuckets(ListBucketsRequest, CallSettings)
public override PagedEnumerable<ListBucketsResponse, LogBucket> ListBuckets(ListBucketsRequest request, CallSettings callSettings = null)Lists log buckets.
| Parameters | |
|---|---|
| Name | Description |
request | ListBucketsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListBucketsResponseLogBucket | A pageable sequence of LogBucket resources. |
ListBucketsAsync(ListBucketsRequest, CallSettings)
public override PagedAsyncEnumerable<ListBucketsResponse, LogBucket> ListBucketsAsync(ListBucketsRequest request, CallSettings callSettings = null)Lists log buckets.
| Parameters | |
|---|---|
| Name | Description |
request | ListBucketsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListBucketsResponseLogBucket | A pageable asynchronous sequence of LogBucket resources. |
ListExclusions(ListExclusionsRequest, CallSettings)
public override PagedEnumerable<ListExclusionsResponse, LogExclusion> ListExclusions(ListExclusionsRequest request, CallSettings callSettings = null)Lists all the exclusions on the _Default sink in a parent resource.
| Parameters | |
|---|---|
| Name | Description |
request | ListExclusionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListExclusionsResponseLogExclusion | A pageable sequence of LogExclusion resources. |
ListExclusionsAsync(ListExclusionsRequest, CallSettings)
public override PagedAsyncEnumerable<ListExclusionsResponse, LogExclusion> ListExclusionsAsync(ListExclusionsRequest request, CallSettings callSettings = null)Lists all the exclusions on the _Default sink in a parent resource.
| Parameters | |
|---|---|
| Name | Description |
request | ListExclusionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListExclusionsResponseLogExclusion | A pageable asynchronous sequence of LogExclusion resources. |
ListLinks(ListLinksRequest, CallSettings)
public override PagedEnumerable<ListLinksResponse, Link> ListLinks(ListLinksRequest request, CallSettings callSettings = null)Lists links.
| Parameters | |
|---|---|
| Name | Description |
request | ListLinksRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListLinksResponseLink | A pageable sequence of Link resources. |
ListLinksAsync(ListLinksRequest, CallSettings)
public override PagedAsyncEnumerable<ListLinksResponse, Link> ListLinksAsync(ListLinksRequest request, CallSettings callSettings = null)Lists links.
| Parameters | |
|---|---|
| Name | Description |
request | ListLinksRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListLinksResponseLink | A pageable asynchronous sequence of Link resources. |
ListSinks(ListSinksRequest, CallSettings)
public override PagedEnumerable<ListSinksResponse, LogSink> ListSinks(ListSinksRequest request, CallSettings callSettings = null)Lists sinks.
| Parameters | |
|---|---|
| Name | Description |
request | ListSinksRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListSinksResponseLogSink | A pageable sequence of LogSink resources. |
ListSinksAsync(ListSinksRequest, CallSettings)
public override PagedAsyncEnumerable<ListSinksResponse, LogSink> ListSinksAsync(ListSinksRequest request, CallSettings callSettings = null)Lists sinks.
| Parameters | |
|---|---|
| Name | Description |
request | ListSinksRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListSinksResponseLogSink | A pageable asynchronous sequence of LogSink resources. |
ListViews(ListViewsRequest, CallSettings)
public override PagedEnumerable<ListViewsResponse, LogView> ListViews(ListViewsRequest request, CallSettings callSettings = null)Lists views on a log bucket.
| Parameters | |
|---|---|
| Name | Description |
request | ListViewsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListViewsResponseLogView | A pageable sequence of LogView resources. |
ListViewsAsync(ListViewsRequest, CallSettings)
public override PagedAsyncEnumerable<ListViewsResponse, LogView> ListViewsAsync(ListViewsRequest request, CallSettings callSettings = null)Lists views on a log bucket.
| Parameters | |
|---|---|
| Name | Description |
request | ListViewsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListViewsResponseLogView | A pageable asynchronous sequence of LogView resources. |
UndeleteBucket(UndeleteBucketRequest, CallSettings)
public override void UndeleteBucket(UndeleteBucketRequest request, CallSettings callSettings = null)Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.
| Parameters | |
|---|---|
| Name | Description |
request | UndeleteBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
UndeleteBucketAsync(UndeleteBucketRequest, CallSettings)
public override Task UndeleteBucketAsync(UndeleteBucketRequest request, CallSettings callSettings = null)Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days.
| Parameters | |
|---|---|
| Name | Description |
request | UndeleteBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
UpdateBucket(UpdateBucketRequest, CallSettings)
public override LogBucket UpdateBucket(UpdateBucketRequest request, CallSettings callSettings = null)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 | UpdateBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogBucket | The RPC response. |
UpdateBucketAsync(UpdateBucketRequest, CallSettings)
public override Task<LogBucket> UpdateBucketAsync(UpdateBucketRequest request, CallSettings callSettings = null)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 | UpdateBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogBucket | A Task containing the RPC response. |
UpdateBucketLongRunning(UpdateBucketRequest, CallSettings)
public override Operation<LogBucket, BucketMetadata> UpdateBucketLongRunning(UpdateBucketRequest request, CallSettings callSettings = null)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 | UpdateBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationLogBucketBucketMetadata | The RPC response. |
UpdateBucketLongRunningAsync(UpdateBucketRequest, CallSettings)
public override Task<Operation<LogBucket, BucketMetadata>> UpdateBucketLongRunningAsync(UpdateBucketRequest request, CallSettings callSettings = null)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 | UpdateBucketRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationLogBucketBucketMetadata | A Task containing the RPC response. |
UpdateCmekSettings(UpdateCmekSettingsRequest, CallSettings)
public override CmekSettings UpdateCmekSettings(UpdateCmekSettingsRequest request, CallSettings callSettings = null)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 | UpdateCmekSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
CmekSettings | The RPC response. |
UpdateCmekSettingsAsync(UpdateCmekSettingsRequest, CallSettings)
public override Task<CmekSettings> UpdateCmekSettingsAsync(UpdateCmekSettingsRequest request, CallSettings callSettings = null)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 | UpdateCmekSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskCmekSettings | A Task containing the RPC response. |
UpdateExclusion(UpdateExclusionRequest, CallSettings)
public override LogExclusion UpdateExclusion(UpdateExclusionRequest request, CallSettings callSettings = null)Changes one or more properties of an existing exclusion in the _Default sink.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateExclusionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogExclusion | The RPC response. |
UpdateExclusionAsync(UpdateExclusionRequest, CallSettings)
public override Task<LogExclusion> UpdateExclusionAsync(UpdateExclusionRequest request, CallSettings callSettings = null)Changes one or more properties of an existing exclusion in the _Default sink.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateExclusionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogExclusion | A Task containing the RPC response. |
UpdateSettings(UpdateSettingsRequest, CallSettings)
public override Settings UpdateSettings(UpdateSettingsRequest request, CallSettings callSettings = null)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 | UpdateSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Settings | The RPC response. |
UpdateSettingsAsync(UpdateSettingsRequest, CallSettings)
public override Task<Settings> UpdateSettingsAsync(UpdateSettingsRequest request, CallSettings callSettings = null)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 | UpdateSettingsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSettings | A Task containing the RPC response. |
UpdateSink(UpdateSinkRequest, CallSettings)
public override LogSink UpdateSink(UpdateSinkRequest request, CallSettings callSettings = null)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 | UpdateSinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogSink | The RPC response. |
UpdateSinkAsync(UpdateSinkRequest, CallSettings)
public override Task<LogSink> UpdateSinkAsync(UpdateSinkRequest request, CallSettings callSettings = null)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 | UpdateSinkRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogSink | A Task containing the RPC response. |
UpdateView(UpdateViewRequest, CallSettings)
public override LogView UpdateView(UpdateViewRequest request, CallSettings callSettings = null)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 | UpdateViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
LogView | The RPC response. |
UpdateViewAsync(UpdateViewRequest, CallSettings)
public override Task<LogView> UpdateViewAsync(UpdateViewRequest request, CallSettings callSettings = null)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 | UpdateViewRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskLogView | A Task containing the RPC response. |