# Discovery Engine API . projects . locations . sampleQuerySets . sampleQueries

## Instance Methods

Close httplib2 connections.

Creates a SampleQuery

Deletes a SampleQuery.

Gets a SampleQuery.

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.

Gets a list of SampleQuerys.

Retrieves the next page of results.

Updates a SampleQuery.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, sampleQueryId=None, x__xgafv=None)`

    Creates a SampleQuery

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

    { # Sample Query captures metadata to be used for evaluation.
      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
      "name": "A String", # Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
        "query": "A String", # Required. The query.
        "targets": [ # List of targets for the query.
          { # Defines the parameters of the query's expected outcome.
            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
              42,
            ],
            "score": 3.14, # Relevance score of the target.
            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
          },
        ],
      },
    }

      sampleQueryId: string, Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys 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:

        { # Sample Query captures metadata to be used for evaluation.
      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
      "name": "A String", # Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
        "query": "A String", # Required. The query.
        "targets": [ # List of targets for the query.
          { # Defines the parameters of the query's expected outcome.
            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
              42,
            ],
            "score": 3.14, # Relevance score of the target.
            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
          },
        ],
      },
    }

`delete(name, x__xgafv=None)`

    Deletes a SampleQuery.

    Args:
      name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery 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 SampleQuery.

    Args:
      name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery 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:

        { # Sample Query captures metadata to be used for evaluation.
      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
      "name": "A String", # Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
        "query": "A String", # Required. The query.
        "targets": [ # List of targets for the query.
          { # Defines the parameters of the query's expected outcome.
            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
              42,
            ],
            "score": 3.14, # Relevance score of the target.
            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
          },
        ],
      },
    }

`import_(parent, body=None, x__xgafv=None)`

    Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.

    Args:
      parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
      body: object, The request body.
        The object takes the form of:

    { # Request message for SampleQueryService.ImportSampleQueries method.
      "bigquerySource": { # BigQuery source import data from. # BigQuery input source.
        "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
        "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
        "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
        "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
        },
        "projectId": "A String", # The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
        "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
      },
      "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import.
        "gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
      },
      "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
        "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
        "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
          "A String",
        ],
      },
      "inlineSource": { # The inline source for SampleQuerys. # The Inline source for sample query entries.
        "sampleQueries": [ # Required. A list of SampleQuerys to import. Max of 1000 items.
          { # Sample Query captures metadata to be used for evaluation.
            "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
            "name": "A String", # Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
            "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
              "query": "A String", # Required. The query.
              "targets": [ # List of targets for the query.
                { # Defines the parameters of the query's expected outcome.
                  "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
                    42,
                  ],
                  "score": 3.14, # Relevance score of the target.
                  "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
                },
              ],
            },
          },
        ],
      },
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

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

    Gets a list of SampleQuerys.

    Args:
      parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
      pageSize: integer, Maximum number of SampleQuerys 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 ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries 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 SampleQueryService.ListSampleQueries method.
      "nextPageToken": "A String", # A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
      "sampleQueries": [ # The SampleQuerys.
        { # Sample Query captures metadata to be used for evaluation.
          "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
          "name": "A String", # Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
          "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
            "query": "A String", # Required. The query.
            "targets": [ # List of targets for the query.
              { # Defines the parameters of the query's expected outcome.
                "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
                  42,
                ],
                "score": 3.14, # Relevance score of the target.
                "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
              },
            ],
          },
        },
      ],
    }

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

    Args:
      name: string, Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. 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:

    { # Sample Query captures metadata to be used for evaluation.
      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
      "name": "A String", # Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
        "query": "A String", # Required. The query.
        "targets": [ # List of targets for the query.
          { # Defines the parameters of the query's expected outcome.
            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
              42,
            ],
            "score": 3.14, # Relevance score of the target.
            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
          },
        ],
      },
    }

      updateMask: string, Indicates which fields in the provided imported 'simple query' 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:

        { # Sample Query captures metadata to be used for evaluation.
      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
      "name": "A String", # Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
        "query": "A String", # Required. The query.
        "targets": [ # List of targets for the query.
          { # Defines the parameters of the query's expected outcome.
            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
              42,
            ],
            "score": 3.14, # Relevance score of the target.
            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
          },
        ],
      },
    }