Smart Device Management API . enterprises . structures

Instance Methods

rooms()

Returns the rooms Resource.

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets a structure managed by the enterprise.

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

Lists structures managed by the enterprise.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets a structure managed by the enterprise.

Args:
  name: string, The name of the structure requested. For example: "enterprises/XYZ/structures/ABC". (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Structure resource represents an instance of enterprise managed home or hotel room.
    "traits": { # Structure traits.
      "a_key": "", # Properties of the object.
    },
    "name": "A String", # Output only. The resource name of the structure. For example: "enterprises/XYZ/structures/ABC".
  }
list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)
Lists structures managed by the enterprise.

Args:
  parent: string, The parent enterprise to list structures under. E.g. "enterprises/XYZ". (required)
  pageSize: integer, Requested page size. Server may return fewer structures than requested. If unspecified, server will pick an appropriate default.
  pageToken: string, The token of the page to retrieve.
  filter: string, Optional filter to list structures.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SmartDeviceManagementService.ListStructures
    "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If this field is omitted, there are no subsequent pages.
    "structures": [ # The list of structures.
      { # Structure resource represents an instance of enterprise managed home or hotel room.
        "traits": { # Structure traits.
          "a_key": "", # Properties of the object.
        },
        "name": "A String", # Output only. The resource name of the structure. For example: "enterprises/XYZ/structures/ABC".
      },
    ],
  }
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.