close()

Close httplib2 connections.

create(parent, body=None, connectorId=None, x__xgafv=None)

Creates a new connector in a given Connect cluster.

Args:
parent: string, Required. The parent Connect cluster in which to create the connector. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`. (required)
body: object, The request body.
The object takes the form of:

{ # A Kafka Connect connector in a given ConnectCluster.
"configs": { # Optional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}
"state": "A String", # Output only. The current state of the connector.
"taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. 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 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector.
"maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay.
"minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.
},
}

connectorId: string, Required. The ID to use for the connector, which will become the final component of the connector's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035. This value is structured like: `my-connector-id`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A Kafka Connect connector in a given ConnectCluster.
"configs": { # Optional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}
"state": "A String", # Output only. The current state of the connector.
"taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. 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 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector.
"maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay.
"minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.
},
}

delete(name, x__xgafv=None)

Deletes a connector.

Args:
  name: string, Required. The name of the connector to delete. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Returns the properties of a single connector.

Args:
name: string, Required. The name of the connector whose configuration to return. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A Kafka Connect connector in a given ConnectCluster.
"configs": { # Optional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}
"state": "A String", # Output only. The current state of the connector.
"taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. 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 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector.
"maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay.
"minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.
},
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists the connectors in a given Connect cluster.

Args:
parent: string, Required. The parent Connect cluster whose connectors are to be listed. Structured like `projects/{project}/locations/{location}/connectClusters/{connect_cluster_id}`. (required)
pageSize: integer, Optional. The maximum number of connectors to return. The service may return fewer than this value. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A page token, received from a previous `ListConnectors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectors` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response for ListConnectors.
"connectors": [ # The list of connectors in the requested parent.
{ # A Kafka Connect connector in a given ConnectCluster.
"configs": { # Optional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}
"state": "A String", # Output only. The current state of the connector.
"taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. 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 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector.
"maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay.
"minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.
},
},
],
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the properties of a connector.

Args:
name: string, Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector} (required)
body: object, The request body.
The object takes the form of:

{ # A Kafka Connect connector in a given ConnectCluster.
"configs": { # Optional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}
"state": "A String", # Output only. The current state of the connector.
"taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. 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 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector.
"maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay.
"minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.
},
}

updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A Kafka Connect connector in a given ConnectCluster.
"configs": { # Optional. Connector config as keys/values. The keys of the map are connector property names, for example: `connector.class`, `tasks.max`, `key.converter`.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the connector. Structured like: projects/{project}/locations/{location}/connectClusters/{connect_cluster}/connectors/{connector}
"state": "A String", # Output only. The current state of the connector.
"taskRestartPolicy": { # Task Retry Policy is implemented on a best-effort basis. 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 30 minutes respectively. # Optional. Restarts the individual tasks of a Connector.
"maximumBackoff": "A String", # Optional. The maximum amount of time to wait before retrying a failed task. This sets an upper bound for the backoff delay.
"minimumBackoff": "A String", # Optional. The minimum amount of time to wait before retrying a failed task. This sets a lower bound for the backoff delay.
},
}

pause(name, body=None, x__xgafv=None)

Pauses the connector and its tasks.

Args:
  name: string, Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for PauseConnector.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for PauseConnector.
}

restart(name, body=None, x__xgafv=None)

Restarts the connector.

Args:
  name: string, Required. The name of the connector to restart. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for RestartConnector.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for RestartConnector.
}

resume(name, body=None, x__xgafv=None)

Resumes the connector and its tasks.

Args:
  name: string, Required. The name of the connector to pause. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for ResumeConnector.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ResumeConnector.
}

stop(name, body=None, x__xgafv=None)

Stops the connector.

Args:
  name: string, Required. The name of the connector to stop. Structured like: projects/{project}/locations/{location}/connectClusters/{connectCluster}/connectors/{connector} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for StopConnector.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for StopConnector.
}

Managed Service for Apache Kafka API . projects . locations . connectClusters . connectors

Instance Methods

Method Details