get(project, zone, reservation, reservationBlock, x__xgafv=None)

Retrieves information about the specified reservation block.

Args:
  project: string, Project ID for this request. (required)
  zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
  reservation: string, The name of the reservation. Name should conform to RFC1035 or be a resource ID. (required)
  reservationBlock: string, The name of the reservation block. Name should conform to RFC1035 or be a resource ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "resource": { # Represents a reservation block resource.
    "count": 42, # [Output Only] The number of resources that are allocated in this reservation block.
    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    "inUseCount": 42, # [Output Only] The number of instances that are currently in use on this reservation block.
    "kind": "compute#reservationBlock", # [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.
    "locationPrefix": "A String", # [Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003
    "name": "A String", # [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
    "physicalTopology": { # [Output Only] The physical topology of the reservation block.
      "block": "A String", # The hash of the capacity block within the cluster.
      "cluster": "A String", # The cluster name of the reservation block.
    },
    "reservationMaintenance": { # Maintenance Info for ReservationBlocks. # [Output Only] Maintenance information for this reservation block.
      "enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
      "maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
      "maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
      "schedulingType": "A String", # The type of maintenance for the reservation.
      "upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
        "canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
        "date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead.
        "latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
        "maintenanceStatus": "A String",
        "startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption. DEPRECATED: Use window_start_time instead. TimeWindow is a container for two strings that represent timestamps in "yyyy-MM-dd'T'HH:mm:ssZ" text format.
          "earliest": "A String",
          "latest": "A String",
        },
        "time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead.
        "type": "A String", # Defines the type of maintenance.
        "windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
        "windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
      },
    },
    "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
    "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
    "status": "A String", # [Output Only] Status of the reservation block.
    "zone": "A String", # [Output Only] Zone in which the reservation block resides.
  },
}

list(project, zone, reservation, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of reservation blocks under a single reservation.

Args:
project: string, Project ID for this request. (required)
zone: string, Name of the zone for this request. Zone name should conform to RFC1035. (required)
reservation: string, The name of the reservation. Name should conform to RFC1035 or be a resource ID. (required)
filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A list of reservation blocks under a single reservation.
"id": "A String", # Unique identifier for the resource; defined by the server.
"items": [ # A list of reservation block resources.
{ # Represents a reservation block resource.
"count": 42, # [Output Only] The number of resources that are allocated in this reservation block.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"inUseCount": 42, # [Output Only] The number of instances that are currently in use on this reservation block.
"kind": "compute#reservationBlock", # [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.
"locationPrefix": "A String", # [Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003
"name": "A String", # [Output Only] The name of this reservation block generated by Google Compute Engine. The name must be 1-63 characters long, and comply with RFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
"physicalTopology": { # [Output Only] The physical topology of the reservation block.
"block": "A String", # The hash of the capacity block within the cluster.
"cluster": "A String", # The cluster name of the reservation block.
},
"reservationMaintenance": { # Maintenance Info for ReservationBlocks. # [Output Only] Maintenance information for this reservation block.
"enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
"maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
"maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
"schedulingType": "A String", # The type of maintenance for the reservation.
"upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"date": "A String", # [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String",
"startTimeWindow": { # Represents a window of time using two timestamps: `earliest` and `latest`. # [Output Only] The start time window of the maintenance disruption. DEPRECATED: Use window_start_time instead. TimeWindow is a container for two strings that represent timestamps in "yyyy-MM-dd'T'HH:mm:ssZ" text format.
"earliest": "A String",
"latest": "A String",
},
"time": "A String", # [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead.
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"status": "A String", # [Output Only] Status of the reservation block.
"zone": "A String", # [Output Only] Zone in which the reservation block resides.
},
],
"kind": "compute#reservationBlock", # Type of the resource. Always compute#reservationBlock for a list of reservation blocks.
"nextPageToken": "A String", # This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
"selfLink": "A String", # Server-defined URL for this resource.
"warning": { # Informational warning message.
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
}

Compute Engine API . reservationBlocks

Instance Methods

Method Details