REST Resource: projects.locations.streams.objects

Resource: StreamObject

A specific stream object (e.g a specific DB table).

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "displayName": string,
  "errors": [
    {
      object (Error)
    }
  ],
  "backfillJob": {
    object (BackfillJob)
  },
  "sourceObject": {
    object (SourceObjectIdentifier)
  }
}
Fields
name

string

Output only. Identifier. The object resource's name.
createTime

string (Timestamp format)

Output only. The creation time of the object.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The last update time of the object.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
displayName

string

Required. Display name.
errors[]

object (Error)

Output only. Active errors on the object.
backfillJob

object (BackfillJob)

The latest backfill job that was initiated for the stream object.
sourceObject

object (SourceObjectIdentifier)

The object identifier in the data source.

BackfillJob

Represents a backfill job on a specific stream object.

JSON representation 
{
  "state": enum (State),
  "trigger": enum (Trigger),
  "lastStartTime": string,
  "lastEndTime": string,
  "errors": [
    {
      object (Error)
    }
  ]
}
Fields
state

enum (State)

Output only. Backfill job state.
trigger

enum (Trigger)

Backfill job's triggering reason.
lastStartTime

string (Timestamp format)

Output only. Backfill job's start time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
lastEndTime

string (Timestamp format)

Output only. Backfill job's end time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
errors[]

object (Error)

Output only. Errors which caused the backfill job to fail.

State

State of the stream object's backfill job.

Enums
STATE_UNSPECIFIED Default value.
NOT_STARTED Backfill job was never started for the stream object (stream has backfill strategy defined as manual or object was explicitly excluded from automatic backfill).
PENDING Backfill job will start pending available resources.
ACTIVE Backfill job is running.
STOPPED Backfill job stopped (next job run will start from beginning).
FAILED Backfill job failed (due to an error).
COMPLETED Backfill completed successfully.
UNSUPPORTED Backfill job failed since the table structure is currently unsupported for backfill.

Trigger

Triggering reason for a backfill job.

Enums
TRIGGER_UNSPECIFIED Default value.
AUTOMATIC Object backfill job was triggered automatically according to the stream's backfill strategy.
MANUAL Object backfill job was triggered manually using the dedicated API.

SourceObjectIdentifier

Represents an identifier of an object in the data source.

JSON representation 
{

  // Union field source_identifier can be only one of the following:
  "oracleIdentifier": {
    object (OracleObjectIdentifier)
  },
  "mysqlIdentifier": {
    object (MysqlObjectIdentifier)
  },
  "postgresqlIdentifier": {
    object (PostgresqlObjectIdentifier)
  },
  "sqlServerIdentifier": {
    object (SqlServerObjectIdentifier)
  }
  // End of list of possible types for union field source_identifier.
}
Fields
Union field source_identifier. The identifier for an object in the data source. source_identifier can be only one of the following:
oracleIdentifier

object (OracleObjectIdentifier)

Oracle data source object identifier.
mysqlIdentifier

object (MysqlObjectIdentifier)

Mysql data source object identifier.
postgresqlIdentifier

object (PostgresqlObjectIdentifier)

PostgreSQL data source object identifier.
sqlServerIdentifier

object (SqlServerObjectIdentifier)

SQLServer data source object identifier.

OracleObjectIdentifier

Oracle data source object identifier.

JSON representation 
{
  "schema": string,
  "table": string
}
Fields
schema

string

Required. The schema name.
table

string

Required. The table name.

MysqlObjectIdentifier

Mysql data source object identifier.

JSON representation 
{
  "database": string,
  "table": string
}
Fields
database

string

Required. The database name.
table

string

Required. The table name.

PostgresqlObjectIdentifier

PostgreSQL data source object identifier.

JSON representation 
{
  "schema": string,
  "table": string
}
Fields
schema

string

Required. The schema name.
table

string

Required. The table name.

SqlServerObjectIdentifier

SQLServer data source object identifier.

JSON representation 
{
  "schema": string,
  "table": string
}
Fields
schema

string

Required. The schema name.
table

string

Required. The table name.

Methods

get

 Use this method to get details about a stream object.

list

 Use this method to list the objects of a specific stream.

lookup

 Use this method to look up a stream object by its source object identifier.

startBackfillJob

 Use this method to start a backfill job for the specified stream object.

stopBackfillJob

 Use this method to stop a backfill job for the specified stream object.