Class LoggingServiceV2.LoggingServiceV2Client (3.3.0) 

public class LoggingServiceV2Client : ClientBase<LoggingServiceV2.LoggingServiceV2Client>

Client for LoggingServiceV2

Inheritance

Object > ClientBase > ClientBase<LoggingServiceV2.LoggingServiceV2Client> > LoggingServiceV2.LoggingServiceV2Client

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LoggingServiceV2Client()

protected LoggingServiceV2Client()

Protected parameterless constructor to allow creation of test doubles.

LoggingServiceV2Client(CallInvoker)

public LoggingServiceV2Client(CallInvoker callInvoker)

Creates a new client for LoggingServiceV2 that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

LoggingServiceV2Client(Channel)

[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public LoggingServiceV2Client(Channel channel)

Creates a new client using a channel.

Parameter
Name Description
channel Grpc.Core.Channel

The channel to use to make remote calls.

LoggingServiceV2Client(ChannelBase)

public LoggingServiceV2Client(ChannelBase channel)

Creates a new client for LoggingServiceV2

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

LoggingServiceV2Client(ClientBase.ClientBaseConfiguration)

protected LoggingServiceV2Client(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration

The client configuration.

Methods

DeleteLog(DeleteLogRequest, CallOptions)

public virtual Empty DeleteLog(DeleteLogRequest request, CallOptions options)

Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.

Parameters
Name Description
request DeleteLogRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
Empty

The response received from the server.

DeleteLog(DeleteLogRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteLog(DeleteLogRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.

Parameters
Name Description
request DeleteLogRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
Empty

The response received from the server.

DeleteLogAsync(DeleteLogRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteLogAsync(DeleteLogRequest request, CallOptions options)

Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.

Parameters
Name Description
request DeleteLogRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

DeleteLogAsync(DeleteLogRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteLogAsync(DeleteLogRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted.

Parameters
Name Description
request DeleteLogRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<Empty>

The call object.

ListLogEntries(ListLogEntriesRequest, CallOptions)

public virtual ListLogEntriesResponse ListLogEntries(ListLogEntriesRequest request, CallOptions options)

Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.

Parameters
Name Description
request ListLogEntriesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListLogEntriesResponse

The response received from the server.

ListLogEntries(ListLogEntriesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListLogEntriesResponse ListLogEntries(ListLogEntriesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.

Parameters
Name Description
request ListLogEntriesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListLogEntriesResponse

The response received from the server.

ListLogEntriesAsync(ListLogEntriesRequest, CallOptions)

public virtual AsyncUnaryCall<ListLogEntriesResponse> ListLogEntriesAsync(ListLogEntriesRequest request, CallOptions options)

Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.

Parameters
Name Description
request ListLogEntriesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<ListLogEntriesResponse>

The call object.

ListLogEntriesAsync(ListLogEntriesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListLogEntriesResponse> ListLogEntriesAsync(ListLogEntriesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists log entries. Use this method to retrieve log entries that originated from a project/folder/organization/billing account. For ways to export log entries, see Exporting Logs.

Parameters
Name Description
request ListLogEntriesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<ListLogEntriesResponse>

The call object.

ListLogs(ListLogsRequest, CallOptions)

public virtual ListLogsResponse ListLogs(ListLogsRequest request, CallOptions options)

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.

Parameters
Name Description
request ListLogsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListLogsResponse

The response received from the server.

ListLogs(ListLogsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListLogsResponse ListLogs(ListLogsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.

Parameters
Name Description
request ListLogsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListLogsResponse

The response received from the server.

ListLogsAsync(ListLogsRequest, CallOptions)

public virtual AsyncUnaryCall<ListLogsResponse> ListLogsAsync(ListLogsRequest request, CallOptions options)

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.

Parameters
Name Description
request ListLogsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<ListLogsResponse>

The call object.

ListLogsAsync(ListLogsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListLogsResponse> ListLogsAsync(ListLogsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.

Parameters
Name Description
request ListLogsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<ListLogsResponse>

The call object.

ListMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest, CallOptions)

public virtual ListMonitoredResourceDescriptorsResponse ListMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request, CallOptions options)

Lists the descriptors for monitored resource types used by Logging.

Parameters
Name Description
request ListMonitoredResourceDescriptorsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
ListMonitoredResourceDescriptorsResponse

The response received from the server.

ListMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListMonitoredResourceDescriptorsResponse ListMonitoredResourceDescriptors(ListMonitoredResourceDescriptorsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the descriptors for monitored resource types used by Logging.

Parameters
Name Description
request ListMonitoredResourceDescriptorsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
ListMonitoredResourceDescriptorsResponse

The response received from the server.

ListMonitoredResourceDescriptorsAsync(ListMonitoredResourceDescriptorsRequest, CallOptions)

public virtual AsyncUnaryCall<ListMonitoredResourceDescriptorsResponse> ListMonitoredResourceDescriptorsAsync(ListMonitoredResourceDescriptorsRequest request, CallOptions options)

Lists the descriptors for monitored resource types used by Logging.

Parameters
Name Description
request ListMonitoredResourceDescriptorsRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<ListMonitoredResourceDescriptorsResponse>

The call object.

ListMonitoredResourceDescriptorsAsync(ListMonitoredResourceDescriptorsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListMonitoredResourceDescriptorsResponse> ListMonitoredResourceDescriptorsAsync(ListMonitoredResourceDescriptorsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the descriptors for monitored resource types used by Logging.

Parameters
Name Description
request ListMonitoredResourceDescriptorsRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<ListMonitoredResourceDescriptorsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override LoggingServiceV2.LoggingServiceV2Client NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration
Returns
Type Description
LoggingServiceV2.LoggingServiceV2Client
Overrides
Grpc.Core.ClientBase<Google.Cloud.Logging.V2.LoggingServiceV2.LoggingServiceV2Client>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

TailLogEntries(CallOptions)

public virtual AsyncDuplexStreamingCall<TailLogEntriesRequest, TailLogEntriesResponse> TailLogEntries(CallOptions options)

Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs.

Parameter
Name Description
options CallOptions

The options for the call.
Returns
Type Description
AsyncDuplexStreamingCall<TailLogEntriesRequest, TailLogEntriesResponse>

The call object.

TailLogEntries(Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncDuplexStreamingCall<TailLogEntriesRequest, TailLogEntriesResponse> TailLogEntries(Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Streaming read of log entries as they are ingested. Until the stream is terminated, it will continue reading logs.

Parameters
Name Description
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncDuplexStreamingCall<TailLogEntriesRequest, TailLogEntriesResponse>

The call object.

WriteLogEntries(WriteLogEntriesRequest, CallOptions)

public virtual WriteLogEntriesResponse WriteLogEntries(WriteLogEntriesRequest request, CallOptions options)

Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)

Parameters
Name Description
request WriteLogEntriesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
WriteLogEntriesResponse

The response received from the server.

WriteLogEntries(WriteLogEntriesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual WriteLogEntriesResponse WriteLogEntries(WriteLogEntriesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)

Parameters
Name Description
request WriteLogEntriesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
WriteLogEntriesResponse

The response received from the server.

WriteLogEntriesAsync(WriteLogEntriesRequest, CallOptions)

public virtual AsyncUnaryCall<WriteLogEntriesResponse> WriteLogEntriesAsync(WriteLogEntriesRequest request, CallOptions options)

Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)

Parameters
Name Description
request WriteLogEntriesRequest

The request to send to the server.
options CallOptions

The options for the call.
Returns
Type Description
AsyncUnaryCall<WriteLogEntriesResponse>

The call object.

WriteLogEntriesAsync(WriteLogEntriesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<WriteLogEntriesResponse> WriteLogEntriesAsync(WriteLogEntriesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Writes log entries to Logging. This API method is the only way to send log entries to Logging. This method is used, directly or indirectly, by the Logging agent (fluentd) and all logging libraries configured to use Logging. A single request may contain log entries for a maximum of 1000 different resources (projects, organizations, billing accounts or folders)

Parameters
Name Description
request WriteLogEntriesRequest

The request to send to the server.
headers Metadata

The initial metadata to send with the call. This parameter is optional.
deadline Nullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken CancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<WriteLogEntriesResponse>

The call object.