public static interface ConfigServiceV2Grpc.AsyncServiceService for configuring sinks used to route log entries.
Methods
copyLogEntries(CopyLogEntriesRequest request, StreamObserver<Operation> responseObserver)
public default void copyLogEntries(CopyLogEntriesRequest request, StreamObserver<Operation> responseObserver)Copies a set of log entries from a log bucket to a Cloud Storage bucket.
| Parameters | |
|---|---|
| Name | Description |
request |
CopyLogEntriesRequest |
responseObserver |
io.grpc.stub.StreamObserver<Operation> |
createBucket(CreateBucketRequest request, StreamObserver<LogBucket> responseObserver)
public default void createBucket(CreateBucketRequest request, StreamObserver<LogBucket> responseObserver)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 |
responseObserver |
io.grpc.stub.StreamObserver<LogBucket> |
createExclusion(CreateExclusionRequest request, StreamObserver<LogExclusion> responseObserver)
public default void createExclusion(CreateExclusionRequest request, StreamObserver<LogExclusion> responseObserver)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 |
responseObserver |
io.grpc.stub.StreamObserver<LogExclusion> |
createSink(CreateSinkRequest request, StreamObserver<LogSink> responseObserver)
public default void createSink(CreateSinkRequest request, StreamObserver<LogSink> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<LogSink> |
createView(CreateViewRequest request, StreamObserver<LogView> responseObserver)
public default void createView(CreateViewRequest request, StreamObserver<LogView> responseObserver)Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateViewRequest |
responseObserver |
io.grpc.stub.StreamObserver<LogView> |
deleteBucket(DeleteBucketRequest request, StreamObserver<Empty> responseObserver)
public default void deleteBucket(DeleteBucketRequest request, StreamObserver<Empty> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
deleteExclusion(DeleteExclusionRequest request, StreamObserver<Empty> responseObserver)
public default void deleteExclusion(DeleteExclusionRequest request, StreamObserver<Empty> responseObserver)Deletes an exclusion in the _Default sink.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteExclusionRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
deleteSink(DeleteSinkRequest request, StreamObserver<Empty> responseObserver)
public default void deleteSink(DeleteSinkRequest request, StreamObserver<Empty> responseObserver) Deletes a sink. If the sink has a unique writer_identity, then that
service account is also deleted.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteSinkRequest |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
deleteView(DeleteViewRequest request, StreamObserver<Empty> responseObserver)
public default void deleteView(DeleteViewRequest request, StreamObserver<Empty> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
getBucket(GetBucketRequest request, StreamObserver<LogBucket> responseObserver)
public default void getBucket(GetBucketRequest request, StreamObserver<LogBucket> responseObserver)Gets a log bucket.
| Parameters | |
|---|---|
| Name | Description |
request |
GetBucketRequest |
responseObserver |
io.grpc.stub.StreamObserver<LogBucket> |
getCmekSettings(GetCmekSettingsRequest request, StreamObserver<CmekSettings> responseObserver)
public default void getCmekSettings(GetCmekSettingsRequest request, StreamObserver<CmekSettings> responseObserver)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 |
responseObserver |
io.grpc.stub.StreamObserver<CmekSettings> |
getExclusion(GetExclusionRequest request, StreamObserver<LogExclusion> responseObserver)
public default void getExclusion(GetExclusionRequest request, StreamObserver<LogExclusion> responseObserver)Gets the description of an exclusion in the _Default sink.
| Parameters | |
|---|---|
| Name | Description |
request |
GetExclusionRequest |
responseObserver |
io.grpc.stub.StreamObserver<LogExclusion> |
getSettings(GetSettingsRequest request, StreamObserver<Settings> responseObserver)
public default void getSettings(GetSettingsRequest request, StreamObserver<Settings> responseObserver)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 |
responseObserver |
io.grpc.stub.StreamObserver<Settings> |
getSink(GetSinkRequest request, StreamObserver<LogSink> responseObserver)
public default void getSink(GetSinkRequest request, StreamObserver<LogSink> responseObserver)Gets a sink.
| Parameters | |
|---|---|
| Name | Description |
request |
GetSinkRequest |
responseObserver |
io.grpc.stub.StreamObserver<LogSink> |
getView(GetViewRequest request, StreamObserver<LogView> responseObserver)
public default void getView(GetViewRequest request, StreamObserver<LogView> responseObserver)Gets a view on a log bucket..
| Parameters | |
|---|---|
| Name | Description |
request |
GetViewRequest |
responseObserver |
io.grpc.stub.StreamObserver<LogView> |
listBuckets(ListBucketsRequest request, StreamObserver<ListBucketsResponse> responseObserver)
public default void listBuckets(ListBucketsRequest request, StreamObserver<ListBucketsResponse> responseObserver)Lists log buckets.
| Parameters | |
|---|---|
| Name | Description |
request |
ListBucketsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListBucketsResponse> |
listExclusions(ListExclusionsRequest request, StreamObserver<ListExclusionsResponse> responseObserver)
public default void listExclusions(ListExclusionsRequest request, StreamObserver<ListExclusionsResponse> responseObserver)Lists all the exclusions on the _Default sink in a parent resource.
| Parameters | |
|---|---|
| Name | Description |
request |
ListExclusionsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListExclusionsResponse> |
listSinks(ListSinksRequest request, StreamObserver<ListSinksResponse> responseObserver)
public default void listSinks(ListSinksRequest request, StreamObserver<ListSinksResponse> responseObserver)Lists sinks.
| Parameters | |
|---|---|
| Name | Description |
request |
ListSinksRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListSinksResponse> |
listViews(ListViewsRequest request, StreamObserver<ListViewsResponse> responseObserver)
public default void listViews(ListViewsRequest request, StreamObserver<ListViewsResponse> responseObserver)Lists views on a log bucket.
| Parameters | |
|---|---|
| Name | Description |
request |
ListViewsRequest |
responseObserver |
io.grpc.stub.StreamObserver<ListViewsResponse> |
undeleteBucket(UndeleteBucketRequest request, StreamObserver<Empty> responseObserver)
public default void undeleteBucket(UndeleteBucketRequest request, StreamObserver<Empty> responseObserver)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 |
responseObserver |
io.grpc.stub.StreamObserver<Empty> |
updateBucket(UpdateBucketRequest request, StreamObserver<LogBucket> responseObserver)
public default void updateBucket(UpdateBucketRequest request, StreamObserver<LogBucket> responseObserver) 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 | |
|---|---|
| Name | Description |
request |
UpdateBucketRequest |
responseObserver |
io.grpc.stub.StreamObserver<LogBucket> |
updateCmekSettings(UpdateCmekSettingsRequest request, StreamObserver<CmekSettings> responseObserver)
public default void updateCmekSettings(UpdateCmekSettingsRequest request, StreamObserver<CmekSettings> responseObserver) 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
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 |
responseObserver |
io.grpc.stub.StreamObserver<CmekSettings> |
updateExclusion(UpdateExclusionRequest request, StreamObserver<LogExclusion> responseObserver)
public default void updateExclusion(UpdateExclusionRequest request, StreamObserver<LogExclusion> responseObserver)Changes one or more properties of an existing exclusion in the _Default sink.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateExclusionRequest |
responseObserver |
io.grpc.stub.StreamObserver<LogExclusion> |
updateSettings(UpdateSettingsRequest request, StreamObserver<Settings> responseObserver)
public default void updateSettings(UpdateSettingsRequest request, StreamObserver<Settings> responseObserver) 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
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 |
responseObserver |
io.grpc.stub.StreamObserver<Settings> |
updateSink(UpdateSinkRequest request, StreamObserver<LogSink> responseObserver)
public default void updateSink(UpdateSinkRequest request, StreamObserver<LogSink> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<LogSink> |
updateView(UpdateViewRequest request, StreamObserver<LogView> responseObserver)
public default void updateView(UpdateViewRequest request, StreamObserver<LogView> responseObserver) 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 |
responseObserver |
io.grpc.stub.StreamObserver<LogView> |