Class ConfigServiceV2Grpc.ConfigServiceV2FutureStub (3.21.0)

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

A stub to allow clients to do ListenableFuture-style rpc calls to service ConfigServiceV2.

Service for configuring sinks used to route log entries.

Inheritance

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

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

protected ConfigServiceV2Grpc.ConfigServiceV2FutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`ConfigServiceV2Grpc.ConfigServiceV2FutureStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

copyLogEntries(CopyLogEntriesRequest request)

public ListenableFuture<Operation> copyLogEntries(CopyLogEntriesRequest request)

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

Parameter
Name	Description
`request`	`CopyLogEntriesRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

createBucket(CreateBucketRequest request)

public ListenableFuture<LogBucket> createBucket(CreateBucketRequest request)

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.

Parameter
Name	Description
`request`	`CreateBucketRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogBucket>`

createBucketAsync(CreateBucketRequest request)

public ListenableFuture<Operation> createBucketAsync(CreateBucketRequest request)

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.

Parameter
Name	Description
`request`	`CreateBucketRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

createExclusion(CreateExclusionRequest request)

public ListenableFuture<LogExclusion> createExclusion(CreateExclusionRequest request)

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.

Parameter
Name	Description
`request`	`CreateExclusionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogExclusion>`

createLink(CreateLinkRequest request)

public ListenableFuture<Operation> createLink(CreateLinkRequest request)

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.

Parameter
Name	Description
`request`	`CreateLinkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

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
Name	Description
`request`	`CreateSinkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogSink>`

createView(CreateViewRequest request)

public ListenableFuture<LogView> createView(CreateViewRequest request)

Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.

Parameter
Name	Description
`request`	`CreateViewRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogView>`

deleteBucket(DeleteBucketRequest request)

public ListenableFuture<Empty> deleteBucket(DeleteBucketRequest request)

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.

Parameter
Name	Description
`request`	`DeleteBucketRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteExclusion(DeleteExclusionRequest request)

public ListenableFuture<Empty> deleteExclusion(DeleteExclusionRequest request)

Deletes an exclusion in the _Default sink.

Parameter
Name	Description
`request`	`DeleteExclusionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteLink(DeleteLinkRequest request)

public ListenableFuture<Operation> deleteLink(DeleteLinkRequest request)

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

Parameter
Name	Description
`request`	`DeleteLinkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

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
Name	Description
`request`	`DeleteSinkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

deleteView(DeleteViewRequest request)

public ListenableFuture<Empty> deleteView(DeleteViewRequest request)

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.

Parameter
Name	Description
`request`	`DeleteViewRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

getBucket(GetBucketRequest request)

public ListenableFuture<LogBucket> getBucket(GetBucketRequest request)

Gets a log bucket.

Parameter
Name	Description
`request`	`GetBucketRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogBucket>`

getCmekSettings(GetCmekSettingsRequest request)

public ListenableFuture<CmekSettings> getCmekSettings(GetCmekSettingsRequest request)

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.

Parameter
Name	Description
`request`	`GetCmekSettingsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<CmekSettings>`

getExclusion(GetExclusionRequest request)

public ListenableFuture<LogExclusion> getExclusion(GetExclusionRequest request)

Gets the description of an exclusion in the _Default sink.

Parameter
Name	Description
`request`	`GetExclusionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogExclusion>`

getLink(GetLinkRequest request)

public ListenableFuture<Link> getLink(GetLinkRequest request)

Gets a link.

Parameter
Name	Description
`request`	`GetLinkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Link>`

getSettings(GetSettingsRequest request)

public ListenableFuture<Settings> getSettings(GetSettingsRequest request)

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.

Parameter
Name	Description
`request`	`GetSettingsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Settings>`

getSink(GetSinkRequest request)

public ListenableFuture<LogSink> getSink(GetSinkRequest request)

Gets a sink.

Parameter
Name	Description
`request`	`GetSinkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogSink>`

getView(GetViewRequest request)

public ListenableFuture<LogView> getView(GetViewRequest request)

Gets a view on a log bucket..

Parameter
Name	Description
`request`	`GetViewRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogView>`

listBuckets(ListBucketsRequest request)

public ListenableFuture<ListBucketsResponse> listBuckets(ListBucketsRequest request)

Lists log buckets.

Parameter
Name	Description
`request`	`ListBucketsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListBucketsResponse>`

listExclusions(ListExclusionsRequest request)

public ListenableFuture<ListExclusionsResponse> listExclusions(ListExclusionsRequest request)

Lists all the exclusions on the _Default sink in a parent resource.

Parameter
Name	Description
`request`	`ListExclusionsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListExclusionsResponse>`

listLinks(ListLinksRequest request)

public ListenableFuture<ListLinksResponse> listLinks(ListLinksRequest request)

Lists links.

Parameter
Name	Description
`request`	`ListLinksRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListLinksResponse>`

listSinks(ListSinksRequest request)

public ListenableFuture<ListSinksResponse> listSinks(ListSinksRequest request)

Lists sinks.

Parameter
Name	Description
`request`	`ListSinksRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListSinksResponse>`

listViews(ListViewsRequest request)

public ListenableFuture<ListViewsResponse> listViews(ListViewsRequest request)

Lists views on a log bucket.

Parameter
Name	Description
`request`	`ListViewsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<ListViewsResponse>`

undeleteBucket(UndeleteBucketRequest request)

public ListenableFuture<Empty> undeleteBucket(UndeleteBucketRequest request)

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

Parameter
Name	Description
`request`	`UndeleteBucketRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Empty>`

updateBucket(UpdateBucketRequest request)

public ListenableFuture<LogBucket> updateBucket(UpdateBucketRequest request)

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.

Parameter
Name	Description
`request`	`UpdateBucketRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogBucket>`

updateBucketAsync(UpdateBucketRequest request)

public ListenableFuture<Operation> updateBucketAsync(UpdateBucketRequest request)

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.

Parameter
Name	Description
`request`	`UpdateBucketRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Operation>`

updateCmekSettings(UpdateCmekSettingsRequest request)

public ListenableFuture<CmekSettings> updateCmekSettings(UpdateCmekSettingsRequest request)

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.

Parameter
Name	Description
`request`	`UpdateCmekSettingsRequest`

Returns
Type	Description
`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 in the _Default sink.

Parameter
Name	Description
`request`	`UpdateExclusionRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogExclusion>`

updateSettings(UpdateSettingsRequest request)

public ListenableFuture<Settings> updateSettings(UpdateSettingsRequest request)

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.

Parameter
Name	Description
`request`	`UpdateSettingsRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<Settings>`

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
Name	Description
`request`	`UpdateSinkRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogSink>`

updateView(UpdateViewRequest request)

public ListenableFuture<LogView> updateView(UpdateViewRequest request)

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.

Parameter
Name	Description
`request`	`UpdateViewRequest`

Returns
Type	Description
`com.google.common.util.concurrent.ListenableFuture<LogView>`