Discovery Engine API . projects . locations . sampleQuerySets

close()

Close httplib2 connections.

create(parent, body=None, sampleQuerySetId=None, x__xgafv=None)

Creates a SampleQuerySet

Args:
  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
  "description": "A String", # The description of the SampleQuerySet.
  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
  "name": "A String", # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
}

  sampleQuerySetId: string, Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
  "description": "A String", # The description of the SampleQuerySet.
  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
  "name": "A String", # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
}

delete(name, x__xgafv=None)

Deletes a SampleQuerySet.

Args:
  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets a SampleQuerySet.

Args:
  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
  "description": "A String", # The description of the SampleQuerySet.
  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
  "name": "A String", # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
}

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

Gets a list of SampleQuerySets.

Args:
  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
  pageSize: integer, Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
  pageToken: string, A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
  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 SampleQuerySetService.ListSampleQuerySets method.
  "nextPageToken": "A String", # A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "sampleQuerySets": [ # The SampleQuerySets.
    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
      "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
      "description": "A String", # The description of the SampleQuerySet.
      "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
      "name": "A String", # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    },
  ],
}

list_next()

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.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a SampleQuerySet.

Args:
  name: string, Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
  body: object, The request body.
    The object takes the form of:

{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
  "description": "A String", # The description of the SampleQuerySet.
  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
  "name": "A String", # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
}

  updateMask: string, Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
  "description": "A String", # The description of the SampleQuerySet.
  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
  "name": "A String", # Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
}