Datastream API . projects . locations . streams . objects

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Use this method to get details about a stream object.

Args:
  name: string, Required. The name of the stream object resource to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A specific stream object (e.g a specific DB table).
  "backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
    "errors": [ # Output only. Errors which caused the backfill job to fail.
      { # Represent a user-facing Error.
        "details": { # Additional information about the error.
          "a_key": "A String",
        },
        "errorTime": "A String", # The time when the error occurred.
        "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
        "message": "A String", # A message containing more information about the error that occurred.
        "reason": "A String", # A title that explains the reason for the error.
      },
    ],
    "lastEndTime": "A String", # Output only. Backfill job's end time.
    "lastStartTime": "A String", # Output only. Backfill job's start time.
    "state": "A String", # Backfill job state.
    "trigger": "A String", # Backfill job's triggering reason.
  },
  "createTime": "A String", # Output only. The creation time of the object.
  "displayName": "A String", # Required. Display name.
  "errors": [ # Output only. Active errors on the object.
    { # Represent a user-facing Error.
      "details": { # Additional information about the error.
        "a_key": "A String",
      },
      "errorTime": "A String", # The time when the error occurred.
      "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
      "message": "A String", # A message containing more information about the error that occurred.
      "reason": "A String", # A title that explains the reason for the error.
    },
  ],
  "name": "A String", # Output only. The object's name.
  "sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.
    "mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
      "database": "A String", # Required. The database name.
      "table": "A String", # Required. The table name.
    },
    "oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
      "schema": "A String", # Required. The schema name.
      "table": "A String", # Required. The table name.
    },
  },
  "updateTime": "A String", # Output only. The last update time of the object.
}

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

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

Args:
  parent: string, Required. The parent stream that owns the collection of objects. (required)
  pageSize: integer, Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.
  pageToken: string, Page token received from a previous `ListStreamObjectsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreamObjectsRequest` 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 containing the objects for a stream.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page.
  "streamObjects": [ # List of stream objects.
    { # A specific stream object (e.g a specific DB table).
      "backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
        "errors": [ # Output only. Errors which caused the backfill job to fail.
          { # Represent a user-facing Error.
            "details": { # Additional information about the error.
              "a_key": "A String",
            },
            "errorTime": "A String", # The time when the error occurred.
            "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
            "message": "A String", # A message containing more information about the error that occurred.
            "reason": "A String", # A title that explains the reason for the error.
          },
        ],
        "lastEndTime": "A String", # Output only. Backfill job's end time.
        "lastStartTime": "A String", # Output only. Backfill job's start time.
        "state": "A String", # Backfill job state.
        "trigger": "A String", # Backfill job's triggering reason.
      },
      "createTime": "A String", # Output only. The creation time of the object.
      "displayName": "A String", # Required. Display name.
      "errors": [ # Output only. Active errors on the object.
        { # Represent a user-facing Error.
          "details": { # Additional information about the error.
            "a_key": "A String",
          },
          "errorTime": "A String", # The time when the error occurred.
          "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
          "message": "A String", # A message containing more information about the error that occurred.
          "reason": "A String", # A title that explains the reason for the error.
        },
      ],
      "name": "A String", # Output only. The object's name.
      "sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.
        "mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
          "database": "A String", # Required. The database name.
          "table": "A String", # Required. The table name.
        },
        "oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
          "schema": "A String", # Required. The schema name.
          "table": "A String", # Required. The table name.
        },
      },
      "updateTime": "A String", # Output only. The last update time of the object.
    },
  ],
}

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.
        

startBackfillJob(object, x__xgafv=None)

Starts backfill job for the specified stream object.

Args:
  object: string, Required. The name of the stream object resource to start a backfill job for. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for manually initiating a backfill job for a specific stream object.
  "object": { # A specific stream object (e.g a specific DB table). # The stream object resource a backfill job was started for.
    "backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
      "errors": [ # Output only. Errors which caused the backfill job to fail.
        { # Represent a user-facing Error.
          "details": { # Additional information about the error.
            "a_key": "A String",
          },
          "errorTime": "A String", # The time when the error occurred.
          "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
          "message": "A String", # A message containing more information about the error that occurred.
          "reason": "A String", # A title that explains the reason for the error.
        },
      ],
      "lastEndTime": "A String", # Output only. Backfill job's end time.
      "lastStartTime": "A String", # Output only. Backfill job's start time.
      "state": "A String", # Backfill job state.
      "trigger": "A String", # Backfill job's triggering reason.
    },
    "createTime": "A String", # Output only. The creation time of the object.
    "displayName": "A String", # Required. Display name.
    "errors": [ # Output only. Active errors on the object.
      { # Represent a user-facing Error.
        "details": { # Additional information about the error.
          "a_key": "A String",
        },
        "errorTime": "A String", # The time when the error occurred.
        "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
        "message": "A String", # A message containing more information about the error that occurred.
        "reason": "A String", # A title that explains the reason for the error.
      },
    ],
    "name": "A String", # Output only. The object's name.
    "sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.
      "mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
        "database": "A String", # Required. The database name.
        "table": "A String", # Required. The table name.
      },
      "oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
        "schema": "A String", # Required. The schema name.
        "table": "A String", # Required. The table name.
      },
    },
    "updateTime": "A String", # Output only. The last update time of the object.
  },
}

stopBackfillJob(object, x__xgafv=None)

Stops the backfill job for the specified stream object.

Args:
  object: string, Required. The name of the stream object resource to stop the backfill job for. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for manually stop a backfill job for a specific stream object.
  "object": { # A specific stream object (e.g a specific DB table). # The stream object resource the backfill job was stopped for.
    "backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
      "errors": [ # Output only. Errors which caused the backfill job to fail.
        { # Represent a user-facing Error.
          "details": { # Additional information about the error.
            "a_key": "A String",
          },
          "errorTime": "A String", # The time when the error occurred.
          "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
          "message": "A String", # A message containing more information about the error that occurred.
          "reason": "A String", # A title that explains the reason for the error.
        },
      ],
      "lastEndTime": "A String", # Output only. Backfill job's end time.
      "lastStartTime": "A String", # Output only. Backfill job's start time.
      "state": "A String", # Backfill job state.
      "trigger": "A String", # Backfill job's triggering reason.
    },
    "createTime": "A String", # Output only. The creation time of the object.
    "displayName": "A String", # Required. Display name.
    "errors": [ # Output only. Active errors on the object.
      { # Represent a user-facing Error.
        "details": { # Additional information about the error.
          "a_key": "A String",
        },
        "errorTime": "A String", # The time when the error occurred.
        "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
        "message": "A String", # A message containing more information about the error that occurred.
        "reason": "A String", # A title that explains the reason for the error.
      },
    ],
    "name": "A String", # Output only. The object's name.
    "sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.
      "mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
        "database": "A String", # Required. The database name.
        "table": "A String", # Required. The table name.
      },
      "oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
        "schema": "A String", # Required. The schema name.
        "table": "A String", # Required. The table name.
      },
    },
    "updateTime": "A String", # Output only. The last update time of the object.
  },
}