Class ConfigServiceV2Grpc.ConfigServiceV2BlockingStub (3.6.4)

public static final class ConfigServiceV2Grpc.ConfigServiceV2BlockingStub extends AbstractBlockingStub<ConfigServiceV2Grpc.ConfigServiceV2BlockingStub>

Service for configuring sinks used to route log entries.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > ConfigServiceV2Grpc.ConfigServiceV2BlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected ConfigServiceV2Grpc.ConfigServiceV2BlockingStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
ConfigServiceV2Grpc.ConfigServiceV2BlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createBucket(CreateBucketRequest request)

public LogBucket createBucket(CreateBucketRequest request)

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

Parameter
Name Description
request CreateBucketRequest
Returns
Type Description
LogBucket

createExclusion(CreateExclusionRequest request)

public LogExclusion createExclusion(CreateExclusionRequest request)

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.

Parameter
Name Description
request CreateExclusionRequest
Returns
Type Description
LogExclusion

createSink(CreateSinkRequest request)

public LogSink createSink(CreateSinkRequest request)

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.

Parameter
Name Description
request CreateSinkRequest
Returns
Type Description
LogSink

createView(CreateViewRequest request)

public LogView createView(CreateViewRequest request)

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

Parameter
Name Description
request CreateViewRequest
Returns
Type Description
LogView

deleteBucket(DeleteBucketRequest request)

public Empty deleteBucket(DeleteBucketRequest request)

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.

Parameter
Name Description
request DeleteBucketRequest
Returns
Type Description
Empty

deleteExclusion(DeleteExclusionRequest request)

public Empty deleteExclusion(DeleteExclusionRequest request)

Deletes an exclusion.

Parameter
Name Description
request DeleteExclusionRequest
Returns
Type Description
Empty

deleteSink(DeleteSinkRequest request)

public Empty deleteSink(DeleteSinkRequest request)

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

Parameter
Name Description
request DeleteSinkRequest
Returns
Type Description
Empty

deleteView(DeleteViewRequest request)

public Empty deleteView(DeleteViewRequest request)

Deletes a view from a bucket.

Parameter
Name Description
request DeleteViewRequest
Returns
Type Description
Empty

getBucket(GetBucketRequest request)

public LogBucket getBucket(GetBucketRequest request)

Gets a bucket.

Parameter
Name Description
request GetBucketRequest
Returns
Type Description
LogBucket

getCmekSettings(GetCmekSettingsRequest request)

public CmekSettings getCmekSettings(GetCmekSettingsRequest request)

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.

Parameter
Name Description
request GetCmekSettingsRequest
Returns
Type Description
CmekSettings

getExclusion(GetExclusionRequest request)

public LogExclusion getExclusion(GetExclusionRequest request)

Gets the description of an exclusion.

Parameter
Name Description
request GetExclusionRequest
Returns
Type Description
LogExclusion

getSink(GetSinkRequest request)

public LogSink getSink(GetSinkRequest request)

Gets a sink.

Parameter
Name Description
request GetSinkRequest
Returns
Type Description
LogSink

getView(GetViewRequest request)

public LogView getView(GetViewRequest request)

Gets a view.

Parameter
Name Description
request GetViewRequest
Returns
Type Description
LogView

listBuckets(ListBucketsRequest request)

public ListBucketsResponse listBuckets(ListBucketsRequest request)

Lists buckets.

Parameter
Name Description
request ListBucketsRequest
Returns
Type Description
ListBucketsResponse

listExclusions(ListExclusionsRequest request)

public ListExclusionsResponse listExclusions(ListExclusionsRequest request)

Lists all the exclusions in a parent resource.

Parameter
Name Description
request ListExclusionsRequest
Returns
Type Description
ListExclusionsResponse

listSinks(ListSinksRequest request)

public ListSinksResponse listSinks(ListSinksRequest request)

Lists sinks.

Parameter
Name Description
request ListSinksRequest
Returns
Type Description
ListSinksResponse

listViews(ListViewsRequest request)

public ListViewsResponse listViews(ListViewsRequest request)

Lists views on a bucket.

Parameter
Name Description
request ListViewsRequest
Returns
Type Description
ListViewsResponse

undeleteBucket(UndeleteBucketRequest request)

public Empty undeleteBucket(UndeleteBucketRequest request)

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

Parameter
Name Description
request UndeleteBucketRequest
Returns
Type Description
Empty

updateBucket(UpdateBucketRequest request)

public LogBucket updateBucket(UpdateBucketRequest request)

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.

Parameter
Name Description
request UpdateBucketRequest
Returns
Type Description
LogBucket

updateCmekSettings(UpdateCmekSettingsRequest request)

public CmekSettings updateCmekSettings(UpdateCmekSettingsRequest request)

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

Parameter
Name Description
request UpdateCmekSettingsRequest
Returns
Type Description
CmekSettings

updateExclusion(UpdateExclusionRequest request)

public LogExclusion updateExclusion(UpdateExclusionRequest request)

Changes one or more properties of an existing exclusion.

Parameter
Name Description
request UpdateExclusionRequest
Returns
Type Description
LogExclusion

updateSink(UpdateSinkRequest request)

public LogSink updateSink(UpdateSinkRequest request)

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.

Parameter
Name Description
request UpdateSinkRequest
Returns
Type Description
LogSink

updateView(UpdateViewRequest request)

public LogView updateView(UpdateViewRequest request)

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

Parameter
Name Description
request UpdateViewRequest
Returns
Type Description
LogView