# Compute Engine API . machineTypes

## Instance Methods

Retrieves the list of machine type resources grouped by scope.

Retrieves the next page of results.

Returns the specified machine type resource.

Retrieves the list of machine type resources available to the specified project.

Retrieves the next page of results.

### Method Details

`aggregatedList(project, maxResults=None, pageToken=None, filter=None)`

    Retrieves the list of machine type resources grouped by scope.

    Args:
      project: string, Project ID for this request. (required)
      maxResults: integer, Maximum count of results to be returned.
      pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
      filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

    The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

    For example, filter=name ne example-instance.

    Returns:
      An object of the form:

        {
        "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
        "items": { # [Output Only] A map of scoped machine type lists.
          "a_key": { # [Output Only] Name of the scope containing this set of machine types.
            "machineTypes": [ # [Output Only] List of machine types contained in this scope.
              { # A Machine Type resource.
                "guestCpus": 42, # [Output Only] The tumber of CPUs exposed to the instance.
                "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
                "kind": "compute#machineType", # Type of the resource.
                "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
                "description": "A String", # [Output Only] An optional textual description of the resource.
                "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
                "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
                "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
                  "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
                  "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
                  "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
                  "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
                  "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
                },
                "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
                "scratchDisks": [ # [Output Only] List of extended scratch disks assigned to the instance.
                  {
                    "diskGb": 42, # Size of the scratch disk, defined in GB.
                  },
                ],
                "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
                "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
                "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
                "name": "A String", # [Output Only] Name of the resource.
              },
            ],
            "warning": { # [Output Only] An informational warning that appears when the machine types list is empty.
              "message": "A String", # [Output Only] Optional human-readable details for this warning.
              "code": "A String", # [Output Only] The warning type identifier for this warning.
              "data": [ # [Output Only] Metadata for this warning in key: value format.
                {
                  "value": "A String", # [Output Only] A warning data value corresponding to the key.
                  "key": "A String", # [Output Only] A key for the warning data.
                },
              ],
            },
          },
        },
        "kind": "compute#machineTypeAggregatedList", # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
      }

`aggregatedList_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.

`get(project, zone, machineType)`

    Returns the specified machine type resource.

    Args:
      project: string, Project ID for this request. (required)
      zone: string, The name of the zone for this request. (required)
      machineType: string, Name of the machine type resource to return. (required)

    Returns:
      An object of the form:

        { # A Machine Type resource.
        "guestCpus": 42, # [Output Only] The tumber of CPUs exposed to the instance.
        "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
        "kind": "compute#machineType", # Type of the resource.
        "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
        "description": "A String", # [Output Only] An optional textual description of the resource.
        "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
        "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
        "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
          "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
          "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
          "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
          "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
          "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
        },
        "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
        "scratchDisks": [ # [Output Only] List of extended scratch disks assigned to the instance.
          {
            "diskGb": 42, # Size of the scratch disk, defined in GB.
          },
        ],
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
        "name": "A String", # [Output Only] Name of the resource.
      }

`list(project, zone, maxResults=None, pageToken=None, filter=None)`

    Retrieves the list of machine type resources available to the specified project.

    Args:
      project: string, Project ID for this request. (required)
      zone: string, The name of the zone for this request. (required)
      maxResults: integer, Maximum count of results to be returned.
      pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
      filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: FIELD_NAME COMPARISON_STRING LITERAL_STRING.

    The FIELD_NAME is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The COMPARISON_STRING must be either eq (equals) or ne (not equals). The LITERAL_STRING is the string value to filter to. The literal value must be valid for the type of field (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.

    For example, filter=name ne example-instance.

    Returns:
      An object of the form:

        { # Contains a list of Machine Type resources.
        "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
        "items": [ # [Output Only] A list of Machine Type resources.
          { # A Machine Type resource.
            "guestCpus": 42, # [Output Only] The tumber of CPUs exposed to the instance.
            "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
            "kind": "compute#machineType", # Type of the resource.
            "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
            "description": "A String", # [Output Only] An optional textual description of the resource.
            "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
            "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
            "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
              "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED.
              "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED.
              "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
              "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE.
              "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
            },
            "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
            "scratchDisks": [ # [Output Only] List of extended scratch disks assigned to the instance.
              {
                "diskGb": 42, # Size of the scratch disk, defined in GB.
              },
            ],
            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
            "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
            "name": "A String", # [Output Only] Name of the resource.
          },
        ],
        "kind": "compute#machineTypeList", # [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
      }

`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.