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
Inherited Members
io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractBlockingStub.<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(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.withWaitForReady()
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
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
copyLogEntries(CopyLogEntriesRequest request)
public Operation copyLogEntries(CopyLogEntriesRequest request)
Copies a set of log entries from a log bucket to a Cloud Storage bucket.
Parameter
Returns
createBucket(CreateBucketRequest request)
public 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
Returns
createExclusion(CreateExclusionRequest request)
public 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
Returns
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
Returns
createView(CreateViewRequest request)
public LogView createView(CreateViewRequest request)
Creates a view over log entries in a log bucket. A bucket may contain a
maximum of 30 views.
Parameter
Returns
deleteBucket(DeleteBucketRequest request)
public 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
Returns
deleteExclusion(DeleteExclusionRequest request)
public Empty deleteExclusion(DeleteExclusionRequest request)
Deletes an exclusion in the _Default sink.
Parameter
Returns
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
Returns
deleteView(DeleteViewRequest request)
public 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
Returns
getBucket(GetBucketRequest request)
public LogBucket getBucket(GetBucketRequest request)
Parameter
Returns
getCmekSettings(GetCmekSettingsRequest request)
public 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
Returns
getExclusion(GetExclusionRequest request)
public LogExclusion getExclusion(GetExclusionRequest request)
Gets the description of an exclusion in the _Default sink.
Parameter
Returns
getSettings(GetSettingsRequest request)
public 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
Returns
getSink(GetSinkRequest request)
public LogSink getSink(GetSinkRequest request)
Parameter
Returns
getView(GetViewRequest request)
public LogView getView(GetViewRequest request)
Gets a view on a log bucket..
Parameter
Returns
listBuckets(ListBucketsRequest request)
public ListBucketsResponse listBuckets(ListBucketsRequest request)
Parameter
Returns
listExclusions(ListExclusionsRequest request)
public ListExclusionsResponse listExclusions(ListExclusionsRequest request)
Lists all the exclusions on the _Default sink in a parent resource.
Parameter
Returns
listSinks(ListSinksRequest request)
public ListSinksResponse listSinks(ListSinksRequest request)
Parameter
Returns
listViews(ListViewsRequest request)
public ListViewsResponse listViews(ListViewsRequest request)
Lists views on a log bucket.
Parameter
Returns
undeleteBucket(UndeleteBucketRequest request)
public 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
Returns
updateBucket(UpdateBucketRequest request)
public LogBucket updateBucket(UpdateBucketRequest request)
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.
Parameter
Returns
updateCmekSettings(UpdateCmekSettingsRequest request)
public 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
Returns
updateExclusion(UpdateExclusionRequest request)
public LogExclusion updateExclusion(UpdateExclusionRequest request)
Changes one or more properties of an existing exclusion in the _Default
sink.
Parameter
Returns
updateSettings(UpdateSettingsRequest request)
public 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
Returns
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
Returns
updateView(UpdateViewRequest request)
public 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
Returns