Console
    Contact Us Start free

    Method: projects.locations.streams.run

    Use this method to start, resume or recover a stream with a non default CDC strategy.

    HTTP request

    POST https://datastream.googleapis.com/v1/{name}:run

    Path parameters

    Parameters
    name

    string

    Required. Name of the stream resource to start, in the format: projects/{projectId}/locations/{location}/streams/{stream_name}

    Request body

    The request body contains data with the following structure:

    JSON representation 
     { 
 "cdcStrategy" 
 : 
 { 
 object (  CdcStrategy 
 
) 
 } 
 , 
 "force" 
 : 
 boolean 
 }
    Fields
    cdcStrategy

    object ( CdcStrategy )

    Optional. The CDC strategy of the stream. If not set, the system's default value will be used.
    force

    boolean

    Optional. Update the stream without validating it.

    Response body

    If successful, the response body contains an instance of Operation .

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the name resource:

    • datastream.streams.update

    For more information, see the IAM documentation .

    CdcStrategy

    The strategy that the stream uses for CDC replication.

    JSON representation 
     { 
 // Union field start_position 
can be only one of the following: 
 "mostRecentStartPosition" 
 : 
 { 
 object (  MostRecentStartPosition 
 
) 
 } 
 , 
 "nextAvailableStartPosition" 
 : 
 { 
 object (  NextAvailableStartPosition 
 
) 
 } 
 , 
 "specificStartPosition" 
 : 
 { 
 object (  SpecificStartPosition 
 
) 
 } 
 // End of list of possible types for union field start_position 
. 
 }
    Fields
    Union field start_position . The position to start reading from when starting, resuming, or recovering the stream. If not set, the system's default value will be used. start_position can be only one of the following:
    mostRecentStartPosition

    object ( MostRecentStartPosition )

    Optional. Start replicating from the most recent position in the source.

    nextAvailableStartPosition

    object ( NextAvailableStartPosition )

    Optional. Resume replication from the next available position in the source.

    specificStartPosition

    object ( SpecificStartPosition )

    Optional. Start replicating from a specific position in the source.

    MostRecentStartPosition

    This type has no fields.

    CDC strategy to start replicating from the most recent position in the source.

    NextAvailableStartPosition

    This type has no fields.

    CDC strategy to resume replication from the next available position in the source.

    SpecificStartPosition

    CDC strategy to start replicating from a specific position in the source.

    JSON representation 
     { 
 // Union field position 
can be only one of the following: 
 "mysqlLogPosition" 
 : 
 { 
 object (  MysqlLogPosition 
 
) 
 } 
 , 
 "oracleScnPosition" 
 : 
 { 
 object (  OracleScnPosition 
 
) 
 } 
 , 
 "sqlServerLsnPosition" 
 : 
 { 
 object (  SqlServerLsnPosition 
 
) 
 } 
 , 
 "mysqlGtidPosition" 
 : 
 { 
 object (  MysqlGtidPosition 
 
) 
 } 
 , 
 "mongodbChangeStreamPosition" 
 : 
 { 
 object (  MongodbChangeStreamPosition 
 
) 
 } 
 // End of list of possible types for union field position 
. 
 }
    Fields

    Union field position .

    position can be only one of the following:

    mysqlLogPosition

    object ( MysqlLogPosition )

    MySQL specific log position to start replicating from.

    oracleScnPosition

    object ( OracleScnPosition )

    Oracle SCN to start replicating from.

    sqlServerLsnPosition

    object ( SqlServerLsnPosition )

    SqlServer LSN to start replicating from.

    mysqlGtidPosition

    object ( MysqlGtidPosition )

    MySQL GTID set to start replicating from.

    mongodbChangeStreamPosition

    object ( MongodbChangeStreamPosition )

    MongoDB change stream position to start replicating from.

    MysqlLogPosition

    MySQL log position

    JSON representation 
     { 
 "logFile" 
 : 
 string 
 , 
 "logPosition" 
 : 
 integer 
 }
    Fields
    logFile

    string

    Required. The binary log file name.
    logPosition

    integer

    Optional. The position within the binary log file. Default is head of file.

    OracleScnPosition

    Oracle SCN position

    JSON representation 
     { 
 "scn" 
 : 
 string 
 }
    Fields
    scn

    string ( int64 format)

    Required. SCN number from where Logs will be read

    SqlServerLsnPosition

    SQL Server LSN position

    JSON representation 
     { 
 "lsn" 
 : 
 string 
 }
    Fields
    lsn

    string

    Required. Log sequence number (LSN) from where Logs will be read

    MysqlGtidPosition

    MySQL GTID position

    JSON representation 
     { 
 "gtidSet" 
 : 
 string 
 }
    Fields
    gtidSet

    string

    Required. The gtid set to start replication from.

    MongodbChangeStreamPosition

    MongoDB change stream position

    JSON representation 
     { 
 "startTime" 
 : 
 string 
 }
    Fields
    startTime

    string ( Timestamp format)

    Required. The timestamp to start change stream from.

    Uses RFC 3339, where generated output will always be Z-normalized and use 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" .
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: