EventRouter Service, REST: Connector.Update

Written by

Updated at December 17, 2024

HTTP request
Path parameters
Body parameters
Response
UpdateConnectorMetadata
Status
Connector
Source
DataStream
MessageQueue
Timer

Updates the specified connector.

HTTP request

PATCH https://serverless-eventrouter.api.cloud.yandex.net/eventrouter/v1/connectors/{connectorId}

Path parameters

Field

Description

connectorId

string

Required field. ID of the connector to update.

Body parameters

{
  "updateMask": "object",
  "name": "string",
  "description": "string",
  "labels": "object",
  "deletionProtection": "boolean"
}

Field	Description
updateMask	object (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.
name	string New name of the connector.
description	string New description of the connector.
labels	object (map<string, string>) New labels of the connector.
deletionProtection	boolean New flag that disallow deletion of the connector.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "connectorId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "busId": "string",
    "folderId": "string",
    "cloudId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "source": {
      // Includes only one of the fields `dataStream`, `messageQueue`, `timer`
      "dataStream": {
        "database": "string",
        "streamName": "string",
        "consumer": "string",
        "serviceAccountId": "string"
      },
      "messageQueue": {
        "queueArn": "string",
        "serviceAccountId": "string",
        "visibilityTimeout": "string",
        "batchSize": "string",
        "pollingTimeout": "string"
      },
      "timer": {
        "cronExpression": "string",
        "timeZone": "string",
        "payload": "string"
      }
      // end of the list of possible fields
    },
    "deletionProtection": "boolean",
    "status": "string"
  }
  // 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.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean 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	UpdateConnectorMetadata 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	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	Connector 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.

UpdateConnectorMetadata

Field

Description

connectorId

string

Required field. ID of the connector that is being updated.

Status

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

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Connector

Field	Description
id	string ID of the connector.
busId	string ID of the bus that the connector belongs to.
folderId	string ID of the folder that the connector resides in.
cloudId	string ID of the cloud that the connector resides in.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
name	string Name of the connector.
description	string Description of the connector.
labels	object (map<string, string>) Resource labels as `key:value` pairs.
source	Source Source of the connector.
deletionProtection	boolean Deletion protection.
status	enum (Status) Status of the connector. `STATUS_UNSPECIFIED` `RUNNING` `STOPPED`: disabled by user `RESOURCE_NOT_FOUND`: source does not exist `PERMISSION_DENIED`: service account does not have read permission on source `SUBJECT_NOT_FOUND`: service account not found `DELETING`: deletion in progress `CREATING`: creation in progress

Source

Field	Description
dataStream	DataStream Includes only one of the fields `dataStream`, `messageQueue`, `timer`.
messageQueue	MessageQueue Includes only one of the fields `dataStream`, `messageQueue`, `timer`.
timer	Timer Includes only one of the fields `dataStream`, `messageQueue`, `timer`.

DataStream

Field	Description
database	string Required field. Stream database. example: /ru-central1/aoegtvhtp8ob******/cc8004q4lbo6******
streamName	string Required field. Stream name, absolute or relative.
consumer	string Required field. Consumer name.
serviceAccountId	string Required field. Service account which has read permission on the stream.

MessageQueue

Field	Description
queueArn	string Required field. Queue ARN. Example: yrn:yc:ymq:ru-central1:aoe***:test
serviceAccountId	string Required field. Service account which has read access to the queue.
visibilityTimeout	string (duration) Queue visibility timeout override.
batchSize	string (int64) Batch size for polling.
pollingTimeout	string (duration) Queue polling timeout.

Timer

Field	Description
cronExpression	string Required field. cron expression, with second precision
timeZone	string time zone, e.g. Europe/Moscow
payload	string payload to send to target

EventRouter Service, REST: Connector.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

ResponseResponse

UpdateConnectorMetadataUpdateConnectorMetadata

StatusStatus

ConnectorConnector

SourceSource

DataStreamDataStream

MessageQueueMessageQueue

TimerTimer

Was the article helpful?