Method: feeds.scheduleTransfer

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

POST https://chronicle.googleapis.com/v1alpha/{name}:scheduleTransfer

Path parameters

Parameters
name

string

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 
{
  "log_type": string,
  "transfer_state": enum (State),
  "error_details": {
    object (ScheduleFeedTransferErrorDetails)
  }
}
Fields
log_type

string

Required. The log_type
transfer_state

enum (State)

Required. The state of this transfer
error_details

object (ScheduleFeedTransferErrorDetails)

Optional. The details why transfer is not successful

Response body

ScheduleFeedTransfer response message.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "transfer_id": string,
  "next_start_time": string
}
Fields
transfer_id

string

Required. The unique identifier of the next feed transfer.
next_start_time

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

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 
{
  "error_code": string,
  "error_message": string
}
Fields
error_code

string

Optional. error_code contains the error code for the transfer. The field is populated for the transfer with failed status
error_message

string

Optional. error_cause contains the information regarding the failure cause.