# Compute Engine API . targetInstances

## Instance Methods

Retrieves the list of target instances grouped by scope.

Retrieves the next page of results.

Deletes the specified TargetInstance resource.

Returns the specified TargetInstance resource.

Creates a TargetInstance resource in the specified project and zone using the data included in the request.

Retrieves the list of TargetInstance resources available to the specified project and zone.

Retrieves the next page of results.

### Method Details

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

    Retrieves the list of target instances grouped by scope.

    Args:
      project: string, Name of the project scoping this request. (required)
      maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
      pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
      filter: string, Optional. Filter expression for filtering listed resources.

    Returns:
      An object of the form:

        {
        "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
        "items": { # A map of scoped target instance lists.
          "a_key": { # Name of the scope containing this set of target instances.
            "targetInstances": [ # List of target instances contained in this scope.
              { # A TargetInstance resource. This resource defines an endpoint VM that terminates traffic of certain protocols.
                  "kind": "compute#targetInstance", # Type of the resource.
                  "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
                  "zone": "A String", # URL of the zone where the target instance resides (output only).
                  "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the VM. Currently only NO_NAT (default value) is supported.
                  "instance": "A String", # The URL to the instance that terminates the relevant traffic.
                  "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
                  "id": "A String", # Unique identifier for the resource; defined by the server (output only).
                  "selfLink": "A String", # Server defined URL for the resource (output only).
                  "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
                },
            ],
            "warning": { # Informational warning which replaces the list of addresses when the list is empty.
              "message": "A String", # Optional human-readable details for this warning.
              "code": "A String", # The warning type identifier for this warning.
              "data": [ # Metadata for this warning in 'key: value' format.
                {
                  "value": "A String", # A warning data value corresponding to the key.
                  "key": "A String", # A key for the warning data.
                },
              ],
            },
          },
        },
        "kind": "compute#targetInstanceAggregatedList", # Type of resource.
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "selfLink": "A String", # Server defined URL for this resource (output only).
      }

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

`delete(project, zone, targetInstance)`

    Deletes the specified TargetInstance resource.

    Args:
      project: string, Name of the project scoping this request. (required)
      zone: string, Name of the zone scoping this request. (required)
      targetInstance: string, Name of the TargetInstance resource to delete. (required)

    Returns:
      An object of the form:

        { # An operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
        "clientOperationId": "A String",
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
        "operationType": "A String",
        "httpErrorMessage": "A String",
        "progress": 42,
        "httpErrorStatusCode": 42,
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
        "warnings": [
          {
            "message": "A String", # Optional human-readable details for this warning.
            "code": "A String", # The warning type identifier for this warning.
            "data": [ # Metadata for this warning in 'key: value' format.
              {
                "value": "A String", # A warning data value corresponding to the key.
                "key": "A String", # A key for the warning data.
              },
            ],
          },
        ],
        "user": "A String",
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource (output only).
        "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
        "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String",
        "selfLink": "A String", # [Output Only] Server defined URL for the resource.
        "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
      }

`get(project, zone, targetInstance)`

    Returns the specified TargetInstance resource.

    Args:
      project: string, Name of the project scoping this request. (required)
      zone: string, Name of the zone scoping this request. (required)
      targetInstance: string, Name of the TargetInstance resource to return. (required)

    Returns:
      An object of the form:

        { # A TargetInstance resource. This resource defines an endpoint VM that terminates traffic of certain protocols.
          "kind": "compute#targetInstance", # Type of the resource.
          "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
          "zone": "A String", # URL of the zone where the target instance resides (output only).
          "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the VM. Currently only NO_NAT (default value) is supported.
          "instance": "A String", # The URL to the instance that terminates the relevant traffic.
          "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
          "id": "A String", # Unique identifier for the resource; defined by the server (output only).
          "selfLink": "A String", # Server defined URL for the resource (output only).
          "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
        }

`insert(project, zone, body)`

    Creates a TargetInstance resource in the specified project and zone using the data included in the request.

    Args:
      project: string, Name of the project scoping this request. (required)
      zone: string, Name of the zone scoping this request. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # A TargetInstance resource. This resource defines an endpoint VM that terminates traffic of certain protocols.
        "kind": "compute#targetInstance", # Type of the resource.
        "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
        "zone": "A String", # URL of the zone where the target instance resides (output only).
        "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the VM. Currently only NO_NAT (default value) is supported.
        "instance": "A String", # The URL to the instance that terminates the relevant traffic.
        "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "selfLink": "A String", # Server defined URL for the resource (output only).
        "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
      }

    Returns:
      An object of the form:

        { # An operation resource, used to manage asynchronous API requests.
        "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
        "clientOperationId": "A String",
        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
        "operationType": "A String",
        "httpErrorMessage": "A String",
        "progress": 42,
        "httpErrorStatusCode": 42,
        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
        "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
        "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
        "warnings": [
          {
            "message": "A String", # Optional human-readable details for this warning.
            "code": "A String", # The warning type identifier for this warning.
            "data": [ # Metadata for this warning in 'key: value' format.
              {
                "value": "A String", # A warning data value corresponding to the key.
                "key": "A String", # A key for the warning data.
              },
            ],
          },
        ],
        "user": "A String",
        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
        "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
        "name": "A String", # [Output Only] Name of the resource (output only).
        "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
        "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
            {
              "message": "A String", # [Output Only] An optional, human-readable error message.
              "code": "A String", # [Output Only] The error type identifier for this error.
              "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
            },
          ],
        },
        "endTime": "A String",
        "selfLink": "A String", # [Output Only] Server defined URL for the resource.
        "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
      }

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

    Retrieves the list of TargetInstance resources available to the specified project and zone.

    Args:
      project: string, Name of the project scoping this request. (required)
      zone: string, Name of the zone scoping this request. (required)
      maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
      pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
      filter: string, Optional. Filter expression for filtering listed resources.

    Returns:
      An object of the form:

        { # Contains a list of TargetInstance resources.
        "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
        "items": [ # A list of TargetInstance resources.
          { # A TargetInstance resource. This resource defines an endpoint VM that terminates traffic of certain protocols.
              "kind": "compute#targetInstance", # Type of the resource.
              "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
              "zone": "A String", # URL of the zone where the target instance resides (output only).
              "natPolicy": "A String", # NAT option controlling how IPs are NAT'ed to the VM. Currently only NO_NAT (default value) is supported.
              "instance": "A String", # The URL to the instance that terminates the relevant traffic.
              "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
              "id": "A String", # Unique identifier for the resource; defined by the server (output only).
              "selfLink": "A String", # Server defined URL for the resource (output only).
              "name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035.
            },
        ],
        "kind": "compute#targetInstanceList", # Type of resource.
        "id": "A String", # Unique identifier for the resource; defined by the server (output only).
        "selfLink": "A String", # Server defined URL for this resource (output only).
      }

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