Class ConfigServiceV2Grpc.ConfigServiceV2FutureStub (3.6.4)

public static final class ConfigServiceV2Grpc.ConfigServiceV2FutureStub extends AbstractFutureStub<ConfigServiceV2Grpc.ConfigServiceV2FutureStub>

Service for configuring sinks used to route log entries.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > ConfigServiceV2Grpc.ConfigServiceV2FutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected ConfigServiceV2Grpc.ConfigServiceV2FutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
ConfigServiceV2Grpc.ConfigServiceV2FutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createBucket(CreateBucketRequest request)

public ListenableFuture<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
NameDescription
requestCreateBucketRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogBucket>

createExclusion(CreateExclusionRequest request)

public ListenableFuture<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
NameDescription
requestCreateExclusionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogExclusion>

createSink(CreateSinkRequest request)

public ListenableFuture<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
NameDescription
requestCreateSinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogSink>

createView(CreateViewRequest request)

public ListenableFuture<LogView> createView(CreateViewRequest request)

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

Parameter
NameDescription
requestCreateViewRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogView>

deleteBucket(DeleteBucketRequest request)

public ListenableFuture<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
NameDescription
requestDeleteBucketRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteExclusion(DeleteExclusionRequest request)

public ListenableFuture<Empty> deleteExclusion(DeleteExclusionRequest request)

Deletes an exclusion.

Parameter
NameDescription
requestDeleteExclusionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteSink(DeleteSinkRequest request)

public ListenableFuture<Empty> deleteSink(DeleteSinkRequest request)

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

Parameter
NameDescription
requestDeleteSinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteView(DeleteViewRequest request)

public ListenableFuture<Empty> deleteView(DeleteViewRequest request)

Deletes a view from a bucket.

Parameter
NameDescription
requestDeleteViewRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

getBucket(GetBucketRequest request)

public ListenableFuture<LogBucket> getBucket(GetBucketRequest request)

Gets a bucket.

Parameter
NameDescription
requestGetBucketRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogBucket>

getCmekSettings(GetCmekSettingsRequest request)

public ListenableFuture<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
NameDescription
requestGetCmekSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CmekSettings>

getExclusion(GetExclusionRequest request)

public ListenableFuture<LogExclusion> getExclusion(GetExclusionRequest request)

Gets the description of an exclusion.

Parameter
NameDescription
requestGetExclusionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogExclusion>

getSink(GetSinkRequest request)

public ListenableFuture<LogSink> getSink(GetSinkRequest request)

Gets a sink.

Parameter
NameDescription
requestGetSinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogSink>

getView(GetViewRequest request)

public ListenableFuture<LogView> getView(GetViewRequest request)

Gets a view.

Parameter
NameDescription
requestGetViewRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogView>

listBuckets(ListBucketsRequest request)

public ListenableFuture<ListBucketsResponse> listBuckets(ListBucketsRequest request)

Lists buckets.

Parameter
NameDescription
requestListBucketsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListBucketsResponse>

listExclusions(ListExclusionsRequest request)

public ListenableFuture<ListExclusionsResponse> listExclusions(ListExclusionsRequest request)

Lists all the exclusions in a parent resource.

Parameter
NameDescription
requestListExclusionsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListExclusionsResponse>

listSinks(ListSinksRequest request)

public ListenableFuture<ListSinksResponse> listSinks(ListSinksRequest request)

Lists sinks.

Parameter
NameDescription
requestListSinksRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListSinksResponse>

listViews(ListViewsRequest request)

public ListenableFuture<ListViewsResponse> listViews(ListViewsRequest request)

Lists views on a bucket.

Parameter
NameDescription
requestListViewsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListViewsResponse>

undeleteBucket(UndeleteBucketRequest request)

public ListenableFuture<Empty> undeleteBucket(UndeleteBucketRequest request)

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

Parameter
NameDescription
requestUndeleteBucketRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Empty>

updateBucket(UpdateBucketRequest request)

public ListenableFuture<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
NameDescription
requestUpdateBucketRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogBucket>

updateCmekSettings(UpdateCmekSettingsRequest request)

public ListenableFuture<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
NameDescription
requestUpdateCmekSettingsRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<CmekSettings>

updateExclusion(UpdateExclusionRequest request)

public ListenableFuture<LogExclusion> updateExclusion(UpdateExclusionRequest request)

Changes one or more properties of an existing exclusion.

Parameter
NameDescription
requestUpdateExclusionRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogExclusion>

updateSink(UpdateSinkRequest request)

public ListenableFuture<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
NameDescription
requestUpdateSinkRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogSink>

updateView(UpdateViewRequest request)

public ListenableFuture<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
NameDescription
requestUpdateViewRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LogView>