Service for configuring sinks used to route log entries.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
ConfigServiceV2Client(ConfigServiceV2Client const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConfigServiceV2Client const &
|
ConfigServiceV2Client(ConfigServiceV2Client &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConfigServiceV2Client &&
|
ConfigServiceV2Client(std::shared_ptr< ConfigServiceV2Connection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< ConfigServiceV2Connection >
|
opts |
Options
|
Operators
operator=(ConfigServiceV2Client const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConfigServiceV2Client const &
|
Returns | |
---|---|
Type | Description |
ConfigServiceV2Client & |
operator=(ConfigServiceV2Client &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
ConfigServiceV2Client &&
|
Returns | |
---|---|
Type | Description |
ConfigServiceV2Client & |
Functions
ListBuckets(std::string const &, Options)
Lists log buckets.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource whose buckets are to be listed: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::LogBucket > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBuckets(google::logging::v2::ListBucketsRequest, Options)
Lists log buckets.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::ListBucketsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::LogBucket > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetBucket(google::logging::v2::GetBucketRequest const &, Options)
Gets a log bucket.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::GetBucketRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogBucket > |
the result of the RPC. The response message type (google.logging.v2.LogBucket) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateBucketAsync(google::logging::v2::CreateBucketRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::CreateBucketRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::LogBucket > > |
A |
CreateBucketAsync(NoAwaitTag, google::logging::v2::CreateBucketRequest const &, Options)
Creates a log bucket asynchronously that can be used to store log entries.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::logging::v2::CreateBucketRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateBucketAsync(google::longrunning::Operation const &, Options)
Creates a log bucket asynchronously that can be used to store log entries.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::LogBucket > > |
UpdateBucketAsync(google::logging::v2::UpdateBucketRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::UpdateBucketRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::LogBucket > > |
A |
UpdateBucketAsync(NoAwaitTag, google::logging::v2::UpdateBucketRequest const &, Options)
Updates a log bucket asynchronously.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::logging::v2::UpdateBucketRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateBucketAsync(google::longrunning::Operation const &, Options)
Updates a log bucket asynchronously.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::LogBucket > > |
CreateBucket(google::logging::v2::CreateBucketRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::CreateBucketRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogBucket > |
the result of the RPC. The response message type (google.logging.v2.LogBucket) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateBucket(google::logging::v2::UpdateBucketRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::UpdateBucketRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogBucket > |
the result of the RPC. The response message type (google.logging.v2.LogBucket) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteBucket(google::logging::v2::DeleteBucketRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::DeleteBucketRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
UndeleteBucket(google::logging::v2::UndeleteBucketRequest const &, Options)
Undeletes a log bucket.
A bucket that has been deleted can be undeleted within the grace period of 7 days.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::UndeleteBucketRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
ListViews(std::string const &, Options)
Lists views on a log bucket.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The bucket whose views are to be listed: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::LogView > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListViews(google::logging::v2::ListViewsRequest, Options)
Lists views on a log bucket.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::ListViewsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::LogView > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetView(google::logging::v2::GetViewRequest const &, Options)
Gets a view on a log bucket.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::GetViewRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogView > |
the result of the RPC. The response message type (google.logging.v2.LogView) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateView(google::logging::v2::CreateViewRequest const &, Options)
Creates a view over log entries in a log bucket.
A bucket may contain a maximum of 30 views.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::CreateViewRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogView > |
the result of the RPC. The response message type (google.logging.v2.LogView) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateView(google::logging::v2::UpdateViewRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::UpdateViewRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogView > |
the result of the RPC. The response message type (google.logging.v2.LogView) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteView(google::logging::v2::DeleteViewRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::DeleteViewRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
ListSinks(std::string const &, Options)
Lists sinks.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource whose sinks are to be listed: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::LogSink > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSinks(google::logging::v2::ListSinksRequest, Options)
Lists sinks.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::ListSinksRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::LogSink > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetSink(std::string const &, Options)
Gets a sink.
Parameters | |
---|---|
Name | Description |
sink_name |
std::string const &
Required. The resource name of the sink: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogSink > |
the result of the RPC. The response message type (google.logging.v2.LogSink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSink(google::logging::v2::GetSinkRequest const &, Options)
Gets a sink.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::GetSinkRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogSink > |
the result of the RPC. The response message type (google.logging.v2.LogSink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSink(std::string const &, google::logging::v2::LogSink const &, Options)
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.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource in which to create the sink: |
sink |
google::logging::v2::LogSink const &
Required. The new sink, whose |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogSink > |
the result of the RPC. The response message type (google.logging.v2.LogSink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSink(google::logging::v2::CreateSinkRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::CreateSinkRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogSink > |
the result of the RPC. The response message type (google.logging.v2.LogSink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateSink(std::string const &, google::logging::v2::LogSink const &, google::protobuf::FieldMask const &, Options)
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.
Parameters | |
---|---|
Name | Description |
sink_name |
std::string const &
Required. The full resource name of the sink to update, including the parent resource and the sink identifier: |
sink |
google::logging::v2::LogSink const &
Required. The updated sink, whose name is the same identifier that appears as part of |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask that specifies the fields in |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogSink > |
the result of the RPC. The response message type (google.logging.v2.LogSink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateSink(std::string const &, google::logging::v2::LogSink const &, Options)
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.
Parameters | |
---|---|
Name | Description |
sink_name |
std::string const &
Required. The full resource name of the sink to update, including the parent resource and the sink identifier: |
sink |
google::logging::v2::LogSink const &
Required. The updated sink, whose name is the same identifier that appears as part of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogSink > |
the result of the RPC. The response message type (google.logging.v2.LogSink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateSink(google::logging::v2::UpdateSinkRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::UpdateSinkRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogSink > |
the result of the RPC. The response message type (google.logging.v2.LogSink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteSink(std::string const &, Options)
Deletes a sink.
If the sink has a unique writer_identity
, then that service account is also deleted.
Parameters | |
---|---|
Name | Description |
sink_name |
std::string const &
Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteSink(google::logging::v2::DeleteSinkRequest const &, Options)
Deletes a sink.
If the sink has a unique writer_identity
, then that service account is also deleted.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::DeleteSinkRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
CreateLink(std::string const &, google::logging::v2::Link const &, std::string const &, Options)
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.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The full resource name of the bucket to create a link for. |
link |
google::logging::v2::Link const &
Required. The new link. |
link_id |
std::string const &
Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::Link > > |
A |
CreateLink(NoAwaitTag, std::string const &, google::logging::v2::Link const &, std::string const &, Options)
Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
link |
google::logging::v2::Link const &
|
link_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateLink(google::logging::v2::CreateLinkRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::CreateLinkRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::Link > > |
A |
CreateLink(NoAwaitTag, google::logging::v2::CreateLinkRequest const &, Options)
Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::logging::v2::CreateLinkRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateLink(google::longrunning::Operation const &, Options)
Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::Link > > |
DeleteLink(std::string const &, Options)
Deletes a link.
This will also delete the corresponding BigQuery linked dataset.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The full resource name of the link to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::LinkMetadata > > |
A |
DeleteLink(NoAwaitTag, std::string const &, Options)
Deletes a link.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteLink(google::logging::v2::DeleteLinkRequest const &, Options)
Deletes a link.
This will also delete the corresponding BigQuery linked dataset.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::DeleteLinkRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::LinkMetadata > > |
A |
DeleteLink(NoAwaitTag, google::logging::v2::DeleteLinkRequest const &, Options)
Deletes a link.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::logging::v2::DeleteLinkRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteLink(google::longrunning::Operation const &, Options)
Deletes a link.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::LinkMetadata > > |
ListLinks(std::string const &, Options)
Lists links.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource whose links are to be listed: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::Link > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListLinks(google::logging::v2::ListLinksRequest, Options)
Lists links.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::ListLinksRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::Link > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLink(std::string const &, Options)
Gets a link.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the link: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::Link > |
the result of the RPC. The response message type (google.logging.v2.Link) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetLink(google::logging::v2::GetLinkRequest const &, Options)
Gets a link.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::GetLinkRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::Link > |
the result of the RPC. The response message type (google.logging.v2.Link) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListExclusions(std::string const &, Options)
Lists all the exclusions on the _Default sink in a parent resource.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource whose exclusions are to be listed. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::LogExclusion > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListExclusions(google::logging::v2::ListExclusionsRequest, Options)
Lists all the exclusions on the _Default sink in a parent resource.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::ListExclusionsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::logging::v2::LogExclusion > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetExclusion(std::string const &, Options)
Gets the description of an exclusion in the _Default sink.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of an existing exclusion: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogExclusion > |
the result of the RPC. The response message type (google.logging.v2.LogExclusion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetExclusion(google::logging::v2::GetExclusionRequest const &, Options)
Gets the description of an exclusion in the _Default sink.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::GetExclusionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogExclusion > |
the result of the RPC. The response message type (google.logging.v2.LogExclusion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateExclusion(std::string const &, google::logging::v2::LogExclusion const &, Options)
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.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource in which to create the exclusion: |
exclusion |
google::logging::v2::LogExclusion const &
Required. The new exclusion, whose |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogExclusion > |
the result of the RPC. The response message type (google.logging.v2.LogExclusion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateExclusion(google::logging::v2::CreateExclusionRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::CreateExclusionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogExclusion > |
the result of the RPC. The response message type (google.logging.v2.LogExclusion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateExclusion(std::string const &, google::logging::v2::LogExclusion const &, google::protobuf::FieldMask const &, Options)
Changes one or more properties of an existing exclusion in the _Default sink.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of the exclusion to update: |
exclusion |
google::logging::v2::LogExclusion const &
Required. New values for the existing exclusion. Only the fields specified in |
update_mask |
google::protobuf::FieldMask const &
Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogExclusion > |
the result of the RPC. The response message type (google.logging.v2.LogExclusion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateExclusion(google::logging::v2::UpdateExclusionRequest const &, Options)
Changes one or more properties of an existing exclusion in the _Default sink.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::UpdateExclusionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::LogExclusion > |
the result of the RPC. The response message type (google.logging.v2.LogExclusion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteExclusion(std::string const &, Options)
Deletes an exclusion in the _Default sink.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name of an existing exclusion to delete: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteExclusion(google::logging::v2::DeleteExclusionRequest const &, Options)
Deletes an exclusion in the _Default sink.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::DeleteExclusionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
GetCmekSettings(google::logging::v2::GetCmekSettingsRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::GetCmekSettingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::CmekSettings > |
the result of the RPC. The response message type (google.logging.v2.CmekSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateCmekSettings(google::logging::v2::UpdateCmekSettingsRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::UpdateCmekSettingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::CmekSettings > |
the result of the RPC. The response message type (google.logging.v2.CmekSettings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSettings(std::string const &, Options)
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.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource for which to retrieve settings. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::Settings > |
the result of the RPC. The response message type (google.logging.v2.Settings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSettings(google::logging::v2::GetSettingsRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::GetSettingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::Settings > |
the result of the RPC. The response message type (google.logging.v2.Settings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateSettings(google::logging::v2::Settings const &, google::protobuf::FieldMask const &, Options)
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.
Parameters | |
---|---|
Name | Description |
settings |
google::logging::v2::Settings const &
Required. The settings to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask identifying which fields from |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::Settings > |
the result of the RPC. The response message type (google.logging.v2.Settings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateSettings(google::logging::v2::UpdateSettingsRequest const &, Options)
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.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::UpdateSettingsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::logging::v2::Settings > |
the result of the RPC. The response message type (google.logging.v2.Settings) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CopyLogEntries(google::logging::v2::CopyLogEntriesRequest const &, Options)
Copies a set of log entries from a log bucket to a Cloud Storage bucket.
Parameters | |
---|---|
Name | Description |
request |
google::logging::v2::CopyLogEntriesRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::CopyLogEntriesResponse > > |
A |
CopyLogEntries(NoAwaitTag, google::logging::v2::CopyLogEntriesRequest const &, Options)
Copies a set of log entries from a log bucket to a Cloud Storage bucket.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::logging::v2::CopyLogEntriesRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CopyLogEntries(google::longrunning::Operation const &, Options)
Copies a set of log entries from a log bucket to a Cloud Storage bucket.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::logging::v2::CopyLogEntriesResponse > > |