com.google.logging.v2

Class ConfigServiceV2Grpc.ConfigServiceV2BlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<ConfigServiceV2Grpc.ConfigServiceV2BlockingStub>

com.google.logging.v2.ConfigServiceV2Grpc.ConfigServiceV2BlockingStub

Enclosing class:

ConfigServiceV2Grpc

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

A stub to allow clients to do synchronous rpc calls to service ConfigServiceV2.

 Service for configuring sinks used to route log entries.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected ConfigServiceV2Grpc.ConfigServiceV2BlockingStub	build(Channel channel, CallOptions callOptions)
com.google.longrunning.Operation	copyLogEntries(CopyLogEntriesRequest request) Copies a set of log entries from a log bucket to a Cloud Storage bucket.
LogBucket	createBucket(CreateBucketRequest request) Creates a log bucket that can be used to store log entries.
com.google.longrunning.Operation	createBucketAsync(CreateBucketRequest request) Creates a log bucket asynchronously that can be used to store log entries.
LogExclusion	createExclusion(CreateExclusionRequest request) Creates a new exclusion in the _Default sink in a specified parent resource.
com.google.longrunning.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.
LogSink	createSink(CreateSinkRequest request) Creates a sink that exports specified log entries to a destination.
LogView	createView(CreateViewRequest request) Creates a view over log entries in a log bucket.
com.google.protobuf.Empty	deleteBucket(DeleteBucketRequest request) Deletes a log bucket.
com.google.protobuf.Empty	deleteExclusion(DeleteExclusionRequest request) Deletes an exclusion in the _Default sink.
com.google.longrunning.Operation	deleteLink(DeleteLinkRequest request) Deletes a link.
com.google.protobuf.Empty	deleteSink(DeleteSinkRequest request) Deletes a sink.
com.google.protobuf.Empty	deleteView(DeleteViewRequest request) Deletes a view on a log bucket.
LogBucket	getBucket(GetBucketRequest request) Gets a log bucket.
CmekSettings	getCmekSettings(GetCmekSettingsRequest request) Gets the Logging CMEK settings for the given resource.
LogExclusion	getExclusion(GetExclusionRequest request) Gets the description of an exclusion in the _Default sink.
Link	getLink(GetLinkRequest request) Gets a link.
Settings	getSettings(GetSettingsRequest request) Gets the Log Router settings for the given resource.
LogSink	getSink(GetSinkRequest request) Gets a sink.
LogView	getView(GetViewRequest request) Gets a view on a log bucket..
ListBucketsResponse	listBuckets(ListBucketsRequest request) Lists log buckets.
ListExclusionsResponse	listExclusions(ListExclusionsRequest request) Lists all the exclusions on the _Default sink in a parent resource.
ListLinksResponse	listLinks(ListLinksRequest request) Lists links.
ListSinksResponse	listSinks(ListSinksRequest request) Lists sinks.
ListViewsResponse	listViews(ListViewsRequest request) Lists views on a log bucket.
com.google.protobuf.Empty	undeleteBucket(UndeleteBucketRequest request) Undeletes a log bucket.
LogBucket	updateBucket(UpdateBucketRequest request) Updates a log bucket.
com.google.longrunning.Operation	updateBucketAsync(UpdateBucketRequest request) Updates a log bucket asynchronously.
CmekSettings	updateCmekSettings(UpdateCmekSettingsRequest request) Updates the Log Router CMEK settings for the given resource.
LogExclusion	updateExclusion(UpdateExclusionRequest request) Changes one or more properties of an existing exclusion in the _Default sink.
Settings	updateSettings(UpdateSettingsRequest request) Updates the Log Router settings for the given resource.
LogSink	updateSink(UpdateSinkRequest request) Updates a sink.
LogView	updateView(UpdateViewRequest request) Updates a view on a log bucket.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

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

Specified by:

build in class AbstractStub<ConfigServiceV2Grpc.ConfigServiceV2BlockingStub>

listBuckets

public ListBucketsResponse listBuckets(ListBucketsRequest request)

 Lists log buckets.
 

getBucket

public LogBucket getBucket(GetBucketRequest request)

 Gets a log bucket.
 

createBucketAsync

public com.google.longrunning.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.
 

updateBucketAsync

public com.google.longrunning.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.
 

createBucket

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.
 

updateBucket

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

deleteBucket

public com.google.protobuf.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.
 

undeleteBucket

public com.google.protobuf.Empty undeleteBucket(UndeleteBucketRequest request)

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

listViews

public ListViewsResponse listViews(ListViewsRequest request)

 Lists views on a log bucket.
 

getView

public LogView getView(GetViewRequest request)

 Gets a view on a log bucket..
 

createView

public LogView createView(CreateViewRequest request)

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

updateView

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.
 

deleteView

public com.google.protobuf.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.
 

listSinks

public ListSinksResponse listSinks(ListSinksRequest request)

 Lists sinks.
 

getSink

public LogSink getSink(GetSinkRequest request)

 Gets a sink.
 

createSink

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.
 

updateSink

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.
 

deleteSink

public com.google.protobuf.Empty deleteSink(DeleteSinkRequest request)

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

createLink

public com.google.longrunning.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.
 

deleteLink

public com.google.longrunning.Operation deleteLink(DeleteLinkRequest request)

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

listLinks

public ListLinksResponse listLinks(ListLinksRequest request)

 Lists links.
 

getLink

public Link getLink(GetLinkRequest request)

 Gets a link.
 

listExclusions

public ListExclusionsResponse listExclusions(ListExclusionsRequest request)

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

getExclusion

public LogExclusion getExclusion(GetExclusionRequest request)

 Gets the description of an exclusion in the _Default sink.
 

createExclusion

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.
 

updateExclusion

public LogExclusion updateExclusion(UpdateExclusionRequest request)

 Changes one or more properties of an existing exclusion in the _Default
 sink.
 

deleteExclusion

public com.google.protobuf.Empty deleteExclusion(DeleteExclusionRequest request)

 Deletes an exclusion in the _Default sink.
 

getCmekSettings

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](https://cloud.google.com/logging/docs/routing/managed-encryption)
 for more information.
 

updateCmekSettings

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][google.logging.v2.ConfigServiceV2.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](https://cloud.google.com/logging/docs/routing/managed-encryption)
 for more information.
 

getSettings

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](https://cloud.google.com/logging/docs/routing/managed-encryption)
 for more information.
 

updateSettings

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][google.logging.v2.ConfigServiceV2.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](https://cloud.google.com/logging/docs/routing/managed-encryption)
 for more information.
 

copyLogEntries

public com.google.longrunning.Operation copyLogEntries(CopyLogEntriesRequest request)

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