- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- State
- ScheduleFeedTransferErrorDetails
- Try it!
Full name: projects.locations.instances.feeds.scheduleTransfer
Schedules a feed transfer for the feed. It passes the data fetched from the last feed transfer to the chronicle ingestion pipeline.
HTTP request
Path parameters
Parameters | |
---|---|
name |
Required. The name of the feed for which we need to schedule the transfer. Format: projects/{project}/locations/{location}/instances/{instance}/feeds/{feed} |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "logType": string, "transferState": enum ( |
Fields | |
---|---|
logType |
Required. The logType |
transferState |
Required. The state of this transfer |
errorDetails |
Optional. The details why transfer is not successful |
Response body
feeds.scheduleTransfer response message.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "transferId": string, "nextStartTime": string } |
Fields | |
---|---|
transferId |
Required. The unique identifier of the next feed transfer. |
nextStartTime |
Required. The customer identifier. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
State
Possible transfer state
Enums | |
---|---|
STATE_UNSPECIFIED |
Default value. This value is unused. |
SUCCEEDED |
Transfer is successful. |
FAILED |
Transfer failed. |
PARTIAL |
Transfer was partial. |
ScheduleFeedTransferErrorDetails
ScheduleFeedTransferErrorDetails contains the error details for the transfer failure.
JSON representation |
---|
{ "errorCode": string, "errorMessage": string } |
Fields | |
---|---|
errorCode |
Optional. errorCode contains the error code for the transfer. The field is populated for the transfer with failed status |
errorMessage |
Optional. errorCause contains the information regarding the failure cause. |