REST Resource: projects.locations.connectClusters.connectors

Resource: Connector

A Kafka Connect connector in a given ConnectCluster.

JSON representation 
{
  "name": string,
  "configs": {
    string: string,
    ...
  },
  "state": enum (State),

  // Union field restart_policy can be only one of the following:
  "taskRestartPolicy": {
    object (TaskRetryPolicy)
  }
  // End of list of possible types for union field restart_policy.
}
Fields
name

string

Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector}
configs

map (key: string, value: string)

Optional. Connector config as keys/values. The keys of the map are connector property names, for example: connector.class, tasks.max, key.converter.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
state

enum (State)

Output only. The current state of the connector.
Union field restart_policy. A policy that specifies how to restart the failed connectors/tasks in a Cluster resource. If not set, the failed connectors/tasks won't be restarted. restart_policy can be only one of the following:
taskRestartPolicy

object (TaskRetryPolicy)

Optional. Restarts the individual tasks of a Connector.

TaskRetryPolicy

Task Retry Policy is implemented on a best-effort basis. The default policy retries tasks with a minimumBackoff of 60 seconds, and a maximumBackoff of 12 hours. You can disable the policy by setting the taskRetryDisabled field to true. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. Note that the delay between consecutive task restarts may not always precisely match the configured settings. This can happen when the ConnectCluster is in rebalancing state or if the ConnectCluster is unresponsive etc. The default values for minimum and maximum backoffs are 60 seconds and 12 hours respectively.

JSON representation 
{
  "minimumBackoff": string,
  "maximumBackoff": string,
  "taskRetryDisabled": boolean
}
Fields
minimumBackoff

string (Duration format)

Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.

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

string (Duration format)

Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay.

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

boolean

Optional. If true, task retry is disabled.

State

The state of the connector.

Enums
STATE_UNSPECIFIED A state was not specified.
UNASSIGNED The connector is not assigned to any tasks, usually transient.
RUNNING The connector is running.
PAUSED The connector has been paused.
FAILED The connector has failed. See logs for why.
RESTARTING The connector is restarting.
STOPPED The connector has been stopped.

Methods

create

 Creates a new connector in a given Connect cluster.

delete

 Deletes a connector.

get

 Returns the properties of a single connector.

list

 Lists the connectors in a given Connect cluster.

patch

 Updates the properties of a connector.

pause

 Pauses the connector and its tasks.

restart

 Restarts the connector.

resume

 Resumes the connector and its tasks.

stop

 Stops the connector.