Contact UsGet started

Cloud Logging Service, gRPC: ExportService.Run

Written by
Updated at November 26, 2024

Run new logs export from log group to sink

gRPC request

rpc Run (RunExportRequest) returns (operation.Operation)

RunExportRequest

{
  "group_id": "string",
  "sink_id": "string",
  "params": {
    "resource_types": [
      "string"
    ],
    "resource_ids": [
      "string"
    ],
    "stream_names": [
      "string"
    ],
    "levels": [
      "Level"
    ],
    "filter": "string"
  },
  "result_filename": "string",
  "since": "google.protobuf.Timestamp",
  "until": "google.protobuf.Timestamp"
}

Field

Description

group_id

string

Required field.

sink_id

string

Required field.

params

ExportParams

Required field.

result_filename

string

Required field.

since

google.protobuf.Timestamp

Required field.

until

google.protobuf.Timestamp

Required field.

ExportParams

Field

Description

resource_types[]

string

resource_ids[]

string

stream_names[]

string

levels[]

enum Level

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

filter

string

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "group_id": "string",
    "sink_id": "string",
    "result_filename": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "group_id": "string",
    "sink_id": "string",
    "params": {
      "resource_types": [
        "string"
      ],
      "resource_ids": [
        "string"
      ],
      "stream_names": [
        "string"
      ],
      "levels": [
        "Level"
      ],
      "filter": "string"
    },
    "result_filename": "string",
    "since": "google.protobuf.Timestamp",
    "until": "google.protobuf.Timestamp"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

RunExportMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

RunExportDetails

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

RunExportMetadata

Field

Description

group_id

string

sink_id

string

result_filename

string

RunExportDetails

Field

Description

group_id

string

sink_id

string

params

ExportParams

result_filename

string

since

google.protobuf.Timestamp

until

google.protobuf.Timestamp

ExportParams

Field

Description

resource_types[]

string

resource_ids[]

string

stream_names[]

string

levels[]

enum Level

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

filter

string
Previous
Overview
Next
Get