Bare Metal Solution API . projects . locations . snapshotSchedulePolicies

Instance Methods

close()

Close httplib2 connections.

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

Create a snapshot schedule policy in the specified project.

delete(name, x__xgafv=None)

Delete a named snapshot schedule policy.

get(name, x__xgafv=None)

Get details of a single snapshot schedule policy.

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

List snapshot schedule policies in a given project and location.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

Update a snapshot schedule policy in the specified project.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, snapshotSchedulePolicyId=None, x__xgafv=None)
Create a snapshot schedule policy in the specified project.

Args:
  parent: string, Required. The parent project and location 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 the snapshot schedule policy.
  "id": "A String", # An identifier for the snapshot schedule policy, generated by the backend.
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The name of the snapshot schedule policy.
  "schedules": [ # The snapshot schedules contained in this policy. You can specify a maximum of 5 schedules.
    { # A snapshot schedule.
      "crontabSpec": "A String", # A crontab-like specification that the schedule uses to take snapshots.
      "prefix": "A String", # A list of snapshot names created in this schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain in this schedule.
    },
  ],
  "state": "A String", # The state of the snapshot schedule policy.
}

  snapshotSchedulePolicyId: string, Required. Snapshot policy ID
  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 the snapshot schedule policy.
  "id": "A String", # An identifier for the snapshot schedule policy, generated by the backend.
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The name of the snapshot schedule policy.
  "schedules": [ # The snapshot schedules contained in this policy. You can specify a maximum of 5 schedules.
    { # A snapshot schedule.
      "crontabSpec": "A String", # A crontab-like specification that the schedule uses to take snapshots.
      "prefix": "A String", # A list of snapshot names created in this schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain in this schedule.
    },
  ],
  "state": "A String", # The state of the snapshot schedule policy.
}
delete(name, x__xgafv=None)
Delete a named snapshot schedule policy.

Args:
  name: string, Required. The name of the snapshot schedule policy 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)
Get details of a single snapshot schedule policy.

Args:
  name: string, Required. Name of the resource. (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 the snapshot schedule policy.
  "id": "A String", # An identifier for the snapshot schedule policy, generated by the backend.
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The name of the snapshot schedule policy.
  "schedules": [ # The snapshot schedules contained in this policy. You can specify a maximum of 5 schedules.
    { # A snapshot schedule.
      "crontabSpec": "A String", # A crontab-like specification that the schedule uses to take snapshots.
      "prefix": "A String", # A list of snapshot names created in this schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain in this schedule.
    },
  ],
  "state": "A String", # The state of the snapshot schedule policy.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List snapshot schedule policies in a given project and location.

Args:
  parent: string, Required. The parent project containing the Snapshot Schedule Policies. (required)
  filter: string, List filter.
  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 message containing the list of snapshot schedule policies.
  "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 the snapshot schedule policy.
      "id": "A String", # An identifier for the snapshot schedule policy, generated by the backend.
      "labels": { # Labels as key value pairs.
        "a_key": "A String",
      },
      "name": "A String", # Output only. The name of the snapshot schedule policy.
      "schedules": [ # The snapshot schedules contained in this policy. You can specify a maximum of 5 schedules.
        { # A snapshot schedule.
          "crontabSpec": "A String", # A crontab-like specification that the schedule uses to take snapshots.
          "prefix": "A String", # A list of snapshot names created in this schedule.
          "retentionCount": 42, # The maximum number of snapshots to retain in this schedule.
        },
      ],
      "state": "A String", # The state of the snapshot schedule policy.
    },
  ],
}
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 snapshot schedule policy in the specified project.

Args:
  name: string, Output only. The name of the snapshot schedule policy. (required)
  body: object, The request body.
    The object takes the form of:

{ # A snapshot schedule policy.
  "description": "A String", # The description of the snapshot schedule policy.
  "id": "A String", # An identifier for the snapshot schedule policy, generated by the backend.
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The name of the snapshot schedule policy.
  "schedules": [ # The snapshot schedules contained in this policy. You can specify a maximum of 5 schedules.
    { # A snapshot schedule.
      "crontabSpec": "A String", # A crontab-like specification that the schedule uses to take snapshots.
      "prefix": "A String", # A list of snapshot names created in this schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain in this schedule.
    },
  ],
  "state": "A String", # The state of the snapshot schedule policy.
}

  updateMask: string, Required. 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 the snapshot schedule policy.
  "id": "A String", # An identifier for the snapshot schedule policy, generated by the backend.
  "labels": { # Labels as key value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Output only. The name of the snapshot schedule policy.
  "schedules": [ # The snapshot schedules contained in this policy. You can specify a maximum of 5 schedules.
    { # A snapshot schedule.
      "crontabSpec": "A String", # A crontab-like specification that the schedule uses to take snapshots.
      "prefix": "A String", # A list of snapshot names created in this schedule.
      "retentionCount": 42, # The maximum number of snapshots to retain in this schedule.
    },
  ],
  "state": "A String", # The state of the snapshot schedule policy.
}