Bare Metal Solution API . projects . locations . osImages

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Get details of a single OS image.

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

Retrieves the list of OS images which are currently approved.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Get details of a single OS image.

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

Returns:
  An object of the form:

    { # Operation System image.
  "applicableInstanceTypes": [ # Instance types this image is applicable to. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
    "A String",
  ],
  "code": "A String", # OS Image code.
  "description": "A String", # OS Image description.
  "name": "A String", # Output only. OS Image's unique name.
  "supportedNetworkTemplates": [ # Network templates that can be used with this OS Image.
    "A String",
  ],
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Retrieves the list of OS images which are currently approved.

Args:
  parent: string, Required. Parent value for ListOSImagesRequest. (required)
  pageSize: integer, Requested page size. The server might return fewer items than requested. If unspecified, server will pick an appropriate default. Notice that page_size field is not supported and won't be respected in the API request for now, will be updated when pagination is supported.
  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:

    { # Request for getting all available OS images.
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
  "osImages": [ # The OS images available.
    { # Operation System image.
      "applicableInstanceTypes": [ # Instance types this image is applicable to. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations)
        "A String",
      ],
      "code": "A String", # OS Image code.
      "description": "A String", # OS Image description.
      "name": "A String", # Output only. OS Image's unique name.
      "supportedNetworkTemplates": [ # Network templates that can be used with this OS Image.
        "A String",
      ],
    },
  ],
}
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.