google_api_data_catalog v0.19.0 GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope View Source

The criteria that select the subspace used for query matching.

Attributes

  • includeGcpPublicDatasets (type: boolean(), default: nil) - If true, include Google Cloud Platform (GCP) public datasets in the search results. Info on GCP public datasets is available at https://cloud.google.com/public-datasets/. By default, GCP public datasets are excluded.

  • includeOrgIds (type: list(String.t), default: nil) - The list of organization IDs to search within. To find your organization ID, follow instructions in https://cloud.google.com/resource-manager/docs/creating-managing-organization.

  • includeProjectIds (type: list(String.t), default: nil) - The list of project IDs to search within. To learn more about the distinction between project names/IDs/numbers, go to https://cloud.google.com/docs/overview/#projects.

  • restrictedLocations (type: list(String.t), default: nil) - Optional. The list of locations to search within.

    1. If empty, search will be performed in all locations;
    2. If any of the locations are NOT in the valid locations list, error will be returned;
    3. Otherwise, search only the given locations for matching results. Typical usage is to leave this field empty. When a location is unreachable as returned in the SearchCatalogResponse.unreachable field, users can repeat the search request with this parameter set to get additional information on the error.

    Valid locations:

    • asia-east1
    • asia-east2
    • asia-northeast1
    • asia-northeast2
    • asia-northeast3
    • asia-south1
    • asia-southeast1
    • australia-southeast1
    • eu
    • europe-north1
    • europe-west1
    • europe-west2
    • europe-west3
    • europe-west4
    • europe-west6
    • global
    • northamerica-northeast1
    • southamerica-east1
    • us
    • us-central1
    • us-east1
    • us-east4
    • us-west1
    • us-west2

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() ::
  %GoogleApi.DataCatalog.V1beta1.Model.GoogleCloudDatacatalogV1beta1SearchCatalogRequestScope{
    includeGcpPublicDatasets: boolean(),
    includeOrgIds: [String.t()],
    includeProjectIds: [String.t()],
    restrictedLocations: [String.t()]
  }

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.