# Resource Views API . zoneViews

## Instance Methods

Add resources to the view.

Delete a resource view.

Get the information of a zonal resource view.

Get the service information of a resource view or a resource.

Create a resource view.

List resource views.

List the resources of the resource view.

Retrieves the next page of results.

Retrieves the next page of results.

Remove resources from the view.

Update the service information of a resource view or a resource.

### Method Details

`addResources(project, zone, resourceView, body)`

    Add resources to the view.

    Args:
      project: string, The project name of the resource view. (required)
      zone: string, The zone name of the resource view. (required)
      resourceView: string, The name of the resource view. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # The request to add resources to the resource view.
        "resources": [ # The list of resources to be added.
          "A String",
        ],
      }

    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", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
        "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
        "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
        "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
        "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
        "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
        "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.
        "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
          {
            "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] Metadata value for this warning.
                "key": "A String", # [Output Only] Metadata key for this warning.
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
        "kind": "resourceviews#operation", # [Output only] Type of the resource.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
        "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", # [Output Only] The time that this operation was completed, in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
      }

`delete(project, zone, resourceView)`

    Delete a resource view.

    Args:
      project: string, The project name of the resource view. (required)
      zone: string, The zone name of the resource view. (required)
      resourceView: string, The name of the resource view. (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", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
        "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
        "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
        "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
        "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
        "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
        "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.
        "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
          {
            "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] Metadata value for this warning.
                "key": "A String", # [Output Only] Metadata key for this warning.
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
        "kind": "resourceviews#operation", # [Output only] Type of the resource.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
        "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", # [Output Only] The time that this operation was completed, in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
      }

`get(project, zone, resourceView)`

    Get the information of a zonal resource view.

    Args:
      project: string, The project name of the resource view. (required)
      zone: string, The zone name of the resource view. (required)
      resourceView: string, The name of the resource view. (required)

    Returns:
      An object of the form:

        { # The resource view object.
          "size": 42, # The total number of resources in the resource view.
          "kind": "resourceviews#resourceView", # Type of the resource.
          "description": "A String", # The detailed description of the resource view.
          "labels": [ # The labels for events.
            { # The Label to be applied to the resource views.
              "value": "A String", # Value of the label.
              "key": "A String", # Key of the label.
            },
          ],
          "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
          "selfLink": "A String", # [Output Only] A self-link to the resource view.
          "fingerprint": "A String", # The fingerprint of the service endpoint information.
          "endpoints": [ # Services endpoint information.
            { # The service endpoint that may be started in a VM.
              "name": "A String", # The name of the service endpoint.
              "port": 42, # The port of the service endpoint.
            },
          ],
          "creationTimestamp": "A String", # The creation time of the resource view.
          "id": "A String", # [Output Only] The ID of the resource view.
          "resources": [ # A list of all resources in the resource view.
            "A String",
          ],
          "name": "A String", # The name of the resource view.
        }

`getService(project, zone, resourceView, resourceName=None)`

    Get the service information of a resource view or a resource.

    Args:
      project: string, The project name of the resource view. (required)
      zone: string, The zone name of the resource view. (required)
      resourceView: string, The name of the resource view. (required)
      resourceName: string, The name of the resource if user wants to get the service information of the resource.

    Returns:
      An object of the form:

        {
        "endpoints": [ # The service information.
          { # The service endpoint that may be started in a VM.
            "name": "A String", # The name of the service endpoint.
            "port": 42, # The port of the service endpoint.
          },
        ],
        "fingerprint": "A String", # The fingerprint of the service information.
      }

`insert(project, zone, body)`

    Create a resource view.

    Args:
      project: string, The project name of the resource view. (required)
      zone: string, The zone name of the resource view. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # The resource view object.
        "size": 42, # The total number of resources in the resource view.
        "kind": "resourceviews#resourceView", # Type of the resource.
        "description": "A String", # The detailed description of the resource view.
        "labels": [ # The labels for events.
          { # The Label to be applied to the resource views.
            "value": "A String", # Value of the label.
            "key": "A String", # Key of the label.
          },
        ],
        "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
        "selfLink": "A String", # [Output Only] A self-link to the resource view.
        "fingerprint": "A String", # The fingerprint of the service endpoint information.
        "endpoints": [ # Services endpoint information.
          { # The service endpoint that may be started in a VM.
            "name": "A String", # The name of the service endpoint.
            "port": 42, # The port of the service endpoint.
          },
        ],
        "creationTimestamp": "A String", # The creation time of the resource view.
        "id": "A String", # [Output Only] The ID of the resource view.
        "resources": [ # A list of all resources in the resource view.
          "A String",
        ],
        "name": "A String", # The name of the resource view.
      }

    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", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
        "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
        "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
        "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
        "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
        "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
        "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.
        "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
          {
            "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] Metadata value for this warning.
                "key": "A String", # [Output Only] Metadata key for this warning.
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
        "kind": "resourceviews#operation", # [Output only] Type of the resource.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
        "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", # [Output Only] The time that this operation was completed, in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
      }

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

    List resource views.

    Args:
      project: string, The project name of the resource view. (required)
      zone: string, The zone name of the resource view. (required)
      pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
      maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)

    Returns:
      An object of the form:

        { # The response to a list request.
        "nextPageToken": "A String", # A token used for pagination.
        "items": [ # The result that contains all resource views that meet the criteria.
          { # The resource view object.
              "size": 42, # The total number of resources in the resource view.
              "kind": "resourceviews#resourceView", # Type of the resource.
              "description": "A String", # The detailed description of the resource view.
              "labels": [ # The labels for events.
                { # The Label to be applied to the resource views.
                  "value": "A String", # Value of the label.
                  "key": "A String", # Key of the label.
                },
              ],
              "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
              "selfLink": "A String", # [Output Only] A self-link to the resource view.
              "fingerprint": "A String", # The fingerprint of the service endpoint information.
              "endpoints": [ # Services endpoint information.
                { # The service endpoint that may be started in a VM.
                  "name": "A String", # The name of the service endpoint.
                  "port": 42, # The port of the service endpoint.
                },
              ],
              "creationTimestamp": "A String", # The creation time of the resource view.
              "id": "A String", # [Output Only] The ID of the resource view.
              "resources": [ # A list of all resources in the resource view.
                "A String",
              ],
              "name": "A String", # The name of the resource view.
            },
        ],
        "kind": "resourceviews#zoneViewsList", # Type of resource.
        "selfLink": "A String", # Server defined URL for this resource (output only).
      }

`listResources(project, zone, resourceView, listState=None, format=None, maxResults=None, pageToken=None, serviceName=None)`

    List the resources of the resource view.

    Args:
      project: string, The project name of the resource view. (required)
      zone: string, The zone name of the resource view. (required)
      resourceView: string, The name of the resource view. (required)
      listState: string, The state of the instance to list. By default, it lists all instances.
        Allowed values
          ALL -
          RUNNING -
      format: string, The requested format of the return value. It can be URL or URL_PORT. A JSON object will be included in the response based on the format. The default format is NONE, which results in no JSON in the response.
        Allowed values
          NONE -
          URL -
          URL_PORT -
      maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)
      pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
      serviceName: string, The service name to return in the response. It is optional and if it is not set, all the service end points will be returned.

    Returns:
      An object of the form:

        { # The response to a list resource request.
        "nextPageToken": "A String", # A token used for pagination.
        "items": [ # The formatted JSON that is requested by the user.
          { # The list response item that contains the resource and end points information.
            "endpoints": { # The list of service end points on the resource.
              "a_key": [ # The name of the service end point.
                42,
              ],
            },
            "resource": "A String", # The full URL of the resource.
          },
        ],
        "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
      }

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

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

`removeResources(project, zone, resourceView, body)`

    Remove resources from the view.

    Args:
      project: string, The project name of the resource view. (required)
      zone: string, The zone name of the resource view. (required)
      resourceView: string, The name of the resource view. (required)
      body: object, The request body. (required)
        The object takes the form of:

    { # The request to remove resources from the resource view.
        "resources": [ # The list of resources to be removed.
          "A String",
        ],
      }

    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", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
        "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
        "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
        "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
        "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
        "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
        "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.
        "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
          {
            "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] Metadata value for this warning.
                "key": "A String", # [Output Only] Metadata key for this warning.
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
        "kind": "resourceviews#operation", # [Output only] Type of the resource.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
        "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", # [Output Only] The time that this operation was completed, in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
      }

`setService(project, zone, resourceView, body)`

    Update the service information of a resource view or a resource.

    Args:
      project: string, The project name of the resource view. (required)
      zone: string, The zone name of the resource view. (required)
      resourceView: string, The name of the resource view. (required)
      body: object, The request body. (required)
        The object takes the form of:

    {
        "resourceName": "A String", # The name of the resource if user wants to update the service information of the resource.
        "endpoints": [ # The service information to be updated.
          { # The service endpoint that may be started in a VM.
            "name": "A String", # The name of the service endpoint.
            "port": 42, # The port of the service endpoint.
          },
        ],
        "fingerprint": "A String", # Fingerprint of the service information; a hash of the contents. This field is used for optimistic locking when updating the service entries.
      }

    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", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
        "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
        "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
        "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
        "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
        "progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
        "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
        "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.
        "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
        "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
          {
            "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] Metadata value for this warning.
                "key": "A String", # [Output Only] Metadata key for this warning.
              },
            ],
          },
        ],
        "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
        "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
        "kind": "resourceviews#operation", # [Output only] Type of the resource.
        "name": "A String", # [Output Only] Name of the resource.
        "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
        "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", # [Output Only] The time that this operation was completed, in RFC3339 text format.
        "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
        "targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
      }