get(projectId, indexId, x__xgafv=None)

Gets an index.

Args:
  projectId: string, Project ID against which to make the request. (required)
  indexId: string, The resource ID of the index to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A minimal index definition.
    "kind": "A String", # The entity kind to which this index applies.
        # Required.
    "projectId": "A String", # Project ID.
        # Output only.
    "indexId": "A String", # The resource ID of the index.
        # Output only.
    "state": "A String", # The state of the index.
        # Output only.
    "ancestor": "A String", # The index's ancestor mode.  Must not be ANCESTOR_MODE_UNSPECIFIED.
        # Required.
    "properties": [ # An ordered sequence of property names and their index attributes.
        # Required.
      { # A property of an index.
        "direction": "A String", # The indexed property's direction.  Must not be DIRECTION_UNSPECIFIED.
            # Required.
        "name": "A String", # The property name to index.
            # Required.
      },
    ],
  }

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

Lists the indexes that match the specified filters.  Datastore uses an
eventually consistent query to fetch the list of indexes and may
occasionally return stale results.

Args:
  projectId: string, Project ID against which to make the request. (required)
  pageSize: integer, The maximum number of items to return.  If zero, then all results will be
returned.
  pageToken: string, The next_page_token value returned from a previous List request, if any.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  filter: string, A parameter

Returns:
  An object of the form:

    { # The response for
      # google.datastore.admin.v1.DatastoreAdmin.ListIndexes.
    "nextPageToken": "A String", # The standard List next-page token.
    "indexes": [ # The indexes.
      { # A minimal index definition.
        "kind": "A String", # The entity kind to which this index applies.
            # Required.
        "projectId": "A String", # Project ID.
            # Output only.
        "indexId": "A String", # The resource ID of the index.
            # Output only.
        "state": "A String", # The state of the index.
            # Output only.
        "ancestor": "A String", # The index's ancestor mode.  Must not be ANCESTOR_MODE_UNSPECIFIED.
            # Required.
        "properties": [ # An ordered sequence of property names and their index attributes.
            # Required.
          { # A property of an index.
            "direction": "A String", # The indexed property's direction.  Must not be DIRECTION_UNSPECIFIED.
                # Required.
            "name": "A String", # The property name to index.
                # Required.
          },
        ],
      },
    ],
  }

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.

Cloud Datastore API . projects . indexes

Instance Methods

Method Details