Discovery Engine API . projects . locations

Instance Methods

collections()

Returns the collections Resource.

dataStores()

Returns the dataStores Resource.

evaluations()

Returns the evaluations Resource.

groundingConfigs()

Returns the groundingConfigs Resource.

operations()

Returns the operations Resource.

rankingConfigs()

Returns the rankingConfigs Resource.

sampleQuerySets()

Returns the sampleQuerySets Resource.

userEvents()

Returns the userEvents Resource.

close()

Close httplib2 connections.

estimateDataSize(location, body=None, x__xgafv=None)

Estimates the data size to be used by a customer.

getAclConfig(name, x__xgafv=None)

Gets the AclConfig.

updateAclConfig(name, body=None, x__xgafv=None)

Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

Method Details

close()
Close httplib2 connections.
estimateDataSize(location, body=None, x__xgafv=None)
Estimates the data size to be used by a customer.

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

{ # Request message for EstimateBillingService.EstimateDataSize method
  "fileDataSource": { # Data source contains files either in Cloud Storage or BigQuery. # Structured or unstructured data.
    "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 (can be project # or ID) that the BigQuery source is in with 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.
    },
    "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 even imports: * `user_event` (default): One JSON UserEvent per line.
      "inputUris": [ # Required. Cloud Storage URIs to input files. 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",
      ],
    },
  },
  "websiteDataSource": { # Data source is a set of website patterns that we crawl to get the total number of websites. # Website data.
    "estimatorUriPatterns": [ # Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.
      { # URI patterns that we use to crawl.
        "exactMatch": True or False, # Whether we infer the generated URI or use the exact provided one.
        "exclusive": True or False, # Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default.
        "providedUriPattern": "A String", # User provided URI pattern. For example, `foo.com/bar/*`.
      },
    ],
  },
}

  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.
  },
}
getAclConfig(name, x__xgafv=None)
Gets the AclConfig.

Args:
  name: string, Required. Resource name of AclConfig, such as `projects/*/locations/*/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED 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:

    { # Access Control Configuration.
  "idpConfig": { # Identity Provider Config. # Identity provider config.
    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
    },
    "idpType": "A String", # Identity provider type configured.
  },
  "name": "A String", # Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
}
updateAclConfig(name, body=None, x__xgafv=None)
Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

Args:
  name: string, Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. 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:

{ # Access Control Configuration.
  "idpConfig": { # Identity Provider Config. # Identity provider config.
    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
    },
    "idpType": "A String", # Identity provider type configured.
  },
  "name": "A String", # Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
}

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

Returns:
  An object of the form:

    { # Access Control Configuration.
  "idpConfig": { # Identity Provider Config. # Identity provider config.
    "externalIdpConfig": { # Third party IDP Config. # External Identity provider config.
      "workforcePoolName": "A String", # Workforce pool name. Example: "locations/global/workforcePools/pool_id"
    },
    "idpType": "A String", # Identity provider type configured.
  },
  "name": "A String", # Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
}