Bare Metal Solution API . projects . locations . volumes . snapshots

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

Args:
  parent: string, Required. The volume to snapshot. (required)
  body: object, The request body.
    The object takes the form of:

{ # A snapshot of a volume. Only boot volumes can have snapshots.
  "createTime": "A String", # Output only. The creation time of the snapshot.
  "description": "A String", # The description of the snapshot.
  "id": "A String", # Output only. An identifier for the snapshot, generated by the backend.
  "name": "A String", # The name of the snapshot.
  "storageVolume": "A String", # Output only. The name of the volume which this snapshot belongs to.
  "type": "A String", # Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A snapshot of a volume. Only boot volumes can have snapshots.
  "createTime": "A String", # Output only. The creation time of the snapshot.
  "description": "A String", # The description of the snapshot.
  "id": "A String", # Output only. An identifier for the snapshot, generated by the backend.
  "name": "A String", # The name of the snapshot.
  "storageVolume": "A String", # Output only. The name of the volume which this snapshot belongs to.
  "type": "A String", # Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc.
}

delete(name, x__xgafv=None)

Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.

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

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.

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

Returns:
  An object of the form:

    { # A snapshot of a volume. Only boot volumes can have snapshots.
  "createTime": "A String", # Output only. The creation time of the snapshot.
  "description": "A String", # The description of the snapshot.
  "id": "A String", # Output only. An identifier for the snapshot, generated by the backend.
  "name": "A String", # The name of the snapshot.
  "storageVolume": "A String", # Output only. The name of the volume which this snapshot belongs to.
  "type": "A String", # Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc.
}

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

Retrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume.

Args:
  parent: string, Required. Parent value for ListVolumesRequest. (required)
  pageSize: integer, Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, A token identifying a page of results from the server.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message containing the list of volume snapshots.
  "nextPageToken": "A String", # A token identifying a page of results from the server.
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
  "volumeSnapshots": [ # The list of snapshots.
    { # A snapshot of a volume. Only boot volumes can have snapshots.
      "createTime": "A String", # Output only. The creation time of the snapshot.
      "description": "A String", # The description of the snapshot.
      "id": "A String", # Output only. An identifier for the snapshot, generated by the backend.
      "name": "A String", # The name of the snapshot.
      "storageVolume": "A String", # Output only. The name of the volume which this snapshot belongs to.
      "type": "A String", # Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc.
    },
  ],
}

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.
        

restoreVolumeSnapshot(volumeSnapshot, body=None, x__xgafv=None)

Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

Args:
  volumeSnapshot: string, Required. Name of the snapshot which will be used to restore its parent volume. (required)
  body: object, The request body.
    The object takes the form of:

{ # Message for restoring a volume snapshot.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}