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

Create a SnapshotSchedulePolicy.

Args:
  parent: string, Required. The parent project containing the SnapshotSchedulePolicy. (required)
  body: object, The request body.
    The object takes the form of:

{ # A snapshot schedule policy.
  "description": "A String", # The description of this SnapshotSchedulePolicy.
  "name": "A String", # Output only. The name of this SnapshotSchedulePolicy.
  "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified.
    { # A snapshot schedule.
      "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots.
      "prefix": "A String", # A string to prefix names of snapshots created under this Schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule.
    },
  ],
  "volumes": [ # The names of the Volumes this policy is associated with.
    "A String",
  ],
}

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

Returns:
  An object of the form:

    { # A snapshot schedule policy.
  "description": "A String", # The description of this SnapshotSchedulePolicy.
  "name": "A String", # Output only. The name of this SnapshotSchedulePolicy.
  "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified.
    { # A snapshot schedule.
      "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots.
      "prefix": "A String", # A string to prefix names of snapshots created under this Schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule.
    },
  ],
  "volumes": [ # The names of the Volumes this policy is associated with.
    "A String",
  ],
}

delete(name, x__xgafv=None)

Delete removes named snapshot schedule policy

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); } The JSON representation for `Empty` is empty JSON object `{}`.
}

get(name, x__xgafv=None)

Get details for a specific snapshot schedule policy

Args:
  name: string, Required. The name of the policy to retrieve. (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 schedule policy.
  "description": "A String", # The description of this SnapshotSchedulePolicy.
  "name": "A String", # Output only. The name of this SnapshotSchedulePolicy.
  "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified.
    { # A snapshot schedule.
      "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots.
      "prefix": "A String", # A string to prefix names of snapshots created under this Schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule.
    },
  ],
  "volumes": [ # The names of the Volumes this policy is associated with.
    "A String",
  ],
}

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

List the snapshot schedule policies for the specified project

Args:
  parent: string, Required. The parent project containing the Snapshot Schedule Policies. (required)
  pageSize: integer, The maximum number of items to return.
  pageToken: string, The next_page_token value returned from a previous List request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListSnapshotSchedulePolicies.
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
  "snapshotSchedulePolicies": [ # The snapshot schedule policies registered in this project.
    { # A snapshot schedule policy.
      "description": "A String", # The description of this SnapshotSchedulePolicy.
      "name": "A String", # Output only. The name of this SnapshotSchedulePolicy.
      "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified.
        { # A snapshot schedule.
          "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots.
          "prefix": "A String", # A string to prefix names of snapshots created under this Schedule.
          "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule.
        },
      ],
      "volumes": [ # The names of the Volumes this policy is associated with.
        "A String",
      ],
    },
  ],
}

list_next(previous_request, previous_response)

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.

patch(name, body=None, updateMask=None, x__xgafv=None)

Update a SnapshotSchedulePolicy.

Args:
  name: string, Output only. The name of this SnapshotSchedulePolicy. (required)
  body: object, The request body.
    The object takes the form of:

{ # A snapshot schedule policy.
  "description": "A String", # The description of this SnapshotSchedulePolicy.
  "name": "A String", # Output only. The name of this SnapshotSchedulePolicy.
  "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified.
    { # A snapshot schedule.
      "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots.
      "prefix": "A String", # A string to prefix names of snapshots created under this Schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule.
    },
  ],
  "volumes": [ # The names of the Volumes this policy is associated with.
    "A String",
  ],
}

  updateMask: string, The list of fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A snapshot schedule policy.
  "description": "A String", # The description of this SnapshotSchedulePolicy.
  "name": "A String", # Output only. The name of this SnapshotSchedulePolicy.
  "schedules": [ # The snapshot Schedules contained in this Policy. At most 5 Schedules may be specified.
    { # A snapshot schedule.
      "crontabSpec": "A String", # The crontab-like specification that this Schedule will use to take snapshots.
      "prefix": "A String", # A string to prefix names of snapshots created under this Schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain under this Schedule.
    },
  ],
  "volumes": [ # The names of the Volumes this policy is associated with.
    "A String",
  ],
}

Bare Metal Solution API . projects . snapshotSchedulePolicies

Instance Methods

Method Details