REST Resource: projects.locations.instances.forwarders

Resource: Forwarder

Forwarder which sends data via Ingestion API. NEXT TAG: 7

JSON representation 
{
  "name": string,
  "display_name": string,
  "config": {
    object (ForwarderConfig)
  },
  "state": enum (State),
  "create_time": string,
  "update_time": string
}
Fields
name

string

Immutable. The resource ID of the Forwarder. Format: projects/{project}/locations/{location}/instances/{instance}/forwarders/{forwarder}
display_name

string

User-specified forwarder name.
config

object (ForwarderConfig)

Forwarder configuration settings.
state

enum (State)

Output only. Current state of a Forwarder.
create_time

string (Timestamp format)

Output only. Timestamp when the Forwarder is created

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
update_time

string (Timestamp format)

Output only. Timestamp when the Forwarder is updated

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ForwarderConfig

ForwarderConfig contains fields which manage the configuration of a given Forwarder. Some settings, such as Metadata and Regex Filters, can interact with individual Collector configurations. NEXT TAG: 5

JSON representation 
{
  "upload_compression": boolean,
  "metadata": {
    object (ForwarderMetadata)
  },
  "regex_filters": [
    {
      object (RegexFilter)
    }
  ],
  "server_settings": {
    object (ServerSettings)
  }
}
Fields
upload_compression

boolean

Determines if uploaded data will be compressed.
metadata

object (ForwarderMetadata)

Metadata applied at the Forwarder level. This can be used in conjunction with, or be overridden by, Metadata applied at the Collector level. Refer to each Metadata field for further information.
regex_filters[]

object (RegexFilter)

RegexFilters applied at the Forwarder level, which can be overridden by filters defined at the Collector level.
server_settings

object (ServerSettings)

Server settings for load balancing and high availability config.

ServerSettings

Server settings for load balancing and high availability configuration. Default configuration values will be applied during resource creation for the following fields when they are missing or zero-valued: - graceful_timeout - drain_timeout NEXT TAG: 5

JSON representation 
{
  "enabled": boolean,
  "graceful_timeout": string,
  "drain_timeout": string,
  "http_settings": {
    object (ForwarderHttpSettings)
  }
}
Fields
enabled

boolean

Describes whether server functionality is enabled on the Forwarder.
graceful_timeout

string (Duration format)

A timeout value, truncated to seconds, after which the forwarder returns a bad readiness/health check and still accepts new connections.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
drain_timeout

string (Duration format)

A timeout value, truncated to seconds, after which the forwarder waits for active connections to successfully close on their own before being closed by the server.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
http_settings

object (ForwarderHttpSettings)

HTTP-specific server settings.

ForwarderHttpSettings

HTTP settings for the Forwarder's server. Default configuration values will be applied during resource creation for the following fields when they are missing or zero-valued: - port - host - read_timeout - read_header_timeout - write_timeout - idle_timeout NEXT TAG: 8

JSON representation 
{
  "port": integer,
  "host": string,
  "read_timeout": string,
  "read_header_timeout": string,
  "write_timeout": string,
  "idle_timeout": string,
  "route_settings": {
    object (RouteSettings)
  }
}
Fields
port

integer

Port number that the HTTP server listens on for health checks from the load balancer.
host

string

IP address, or hostname that can be resolved to IP addresses, that the server should listen on.
read_timeout

string (Duration format)

Maximum amount of time, truncated to seconds, allowed to read the entire request, both the header and the body.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
read_header_timeout

string (Duration format)

Maximum amount of time, truncated to seconds, allowed to read request headers.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
write_timeout

string (Duration format)

Maximum amount of time, truncated to seconds, allowed to send a response.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
idle_timeout

string (Duration format)

Maximum amount of time, truncated to seconds, to wait for the next request when idle connections are enabled.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
route_settings

object (RouteSettings)

Route-specific settings for the HTTP server.

RouteSettings

User-configurable routes settings for the Forwarder's HTTP Server Default configuration values will be applied during resource creation for the following fields when they are missing or zero-valued: - available_status_code - ready_status_code - unready_status_code NEXT TAG: 4

JSON representation 
{
  "available_status_code": integer,
  "ready_status_code": integer,
  "unready_status_code": integer
}
Fields
available_status_code

integer

Status code returned when a liveness check is received and the forwarder is available.
ready_status_code

integer

Status code returned when it is ready to accept traffic.
unready_status_code

integer

Status code returned when it is not ready to accept traffic.

State

Life-Cycle States of a Forwarder.

Enums
STATE_UNSPECIFIED The default value. This value is used if the state is omitted.
ACTIVE Forwarder is allowed to upload data.
SUSPENDED Forwarder is not allowed to upload data.

Methods

create

 Create a forwarder.

delete

 Delete a forwarder by forwarder ID.

generateForwarderFiles

 Generates a forwarder's configuration files.

get

 Get a forwarder by forwarder ID.

list

 List all forwarders for the instance.

patch

 Update a forwarder.