Dataflow API . projects . snapshots

Instance Methods

get(projectId=*, snapshotId=*, location=None, x__xgafv=None)

Gets information about a snapshot.

list(projectId=*, jobId=None, location=None, x__xgafv=None)

Lists snapshots.

Method Details

get(projectId=*, snapshotId=*, location=None, x__xgafv=None)
Gets information about a snapshot.

Args:
  projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required)
  snapshotId: string, The ID of the snapshot. (required)
  location: string, The location that contains this snapshot.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a snapshot of a job.
    "sourceJobId": "A String", # The job this snapshot was created from.
    "diskSizeBytes": "A String", # The disk byte size of the snapshot. Only available for snapshots in READY
        # state.
    "description": "A String", # User specified description of the snapshot. Maybe empty.
    "projectId": "A String", # The project this snapshot belongs to.
    "creationTime": "A String", # The time this snapshot was created.
    "state": "A String", # State of the snapshot.
    "ttl": "A String", # The time after which this snapshot will be automatically deleted.
    "pubsubMetadata": [ # PubSub snapshot metadata.
      { # Represents a Pubsub snapshot.
        "expireTime": "A String", # The expire time of the Pubsub snapshot.
        "snapshotName": "A String", # The name of the Pubsub snapshot.
        "topicName": "A String", # The name of the Pubsub topic.
      },
    ],
    "id": "A String", # The unique ID of this snapshot.
  }
list(projectId=*, jobId=None, location=None, x__xgafv=None)
Lists snapshots.

Args:
  projectId: string, The project ID to list snapshots for. (required)
  jobId: string, If specified, list snapshots created from this job.
  location: string, The location to list snapshots in.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # List of snapshots.
    "snapshots": [ # Returned snapshots.
      { # Represents a snapshot of a job.
        "sourceJobId": "A String", # The job this snapshot was created from.
        "diskSizeBytes": "A String", # The disk byte size of the snapshot. Only available for snapshots in READY
            # state.
        "description": "A String", # User specified description of the snapshot. Maybe empty.
        "projectId": "A String", # The project this snapshot belongs to.
        "creationTime": "A String", # The time this snapshot was created.
        "state": "A String", # State of the snapshot.
        "ttl": "A String", # The time after which this snapshot will be automatically deleted.
        "pubsubMetadata": [ # PubSub snapshot metadata.
          { # Represents a Pubsub snapshot.
            "expireTime": "A String", # The expire time of the Pubsub snapshot.
            "snapshotName": "A String", # The name of the Pubsub snapshot.
            "topicName": "A String", # The name of the Pubsub topic.
          },
        ],
        "id": "A String", # The unique ID of this snapshot.
      },
    ],
  }