Interface SearchCatalogRequest.ScopeOrBuilder (1.42.0)

Version 1.42.0

• 1.60.0 (latest)
• 1.59.0
• 1.58.0
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

public static interface SearchCatalogRequest.ScopeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIncludeGcpPublicDatasets()

public abstract boolean getIncludeGcpPublicDatasets()

If true, include Google Cloud public datasets in the search results. Info on Google Cloud public datasets is available at https://cloud.google.com/public-datasets/. By default, Google Cloud public datasets are excluded.

bool include_gcp_public_datasets = 7;

Returns
Type	Description
boolean	The includeGcpPublicDatasets.

getIncludeOrgIds(int index)

public abstract String getIncludeOrgIds(int index)

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.

repeated string include_org_ids = 2;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The includeOrgIds at the given index.

getIncludeOrgIdsBytes(int index)

public abstract ByteString getIncludeOrgIdsBytes(int index)

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.

repeated string include_org_ids = 2;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the includeOrgIds at the given index.

getIncludeOrgIdsCount()

public abstract int getIncludeOrgIdsCount()

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.

repeated string include_org_ids = 2;

Returns
Type	Description
int	The count of includeOrgIds.

getIncludeOrgIdsList()

public abstract List<String> getIncludeOrgIdsList()

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.

repeated string include_org_ids = 2;

Returns
Type	Description
List<String>	A list containing the includeOrgIds.

getIncludeProjectIds(int index)

public abstract String getIncludeProjectIds(int index)

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.

repeated string include_project_ids = 3;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The includeProjectIds at the given index.

getIncludeProjectIdsBytes(int index)

public abstract ByteString getIncludeProjectIdsBytes(int index)

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.

repeated string include_project_ids = 3;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the includeProjectIds at the given index.

getIncludeProjectIdsCount()

public abstract int getIncludeProjectIdsCount()

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.

repeated string include_project_ids = 3;

Returns
Type	Description
int	The count of includeProjectIds.

getIncludeProjectIdsList()

public abstract List<String> getIncludeProjectIdsList()

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.

repeated string include_project_ids = 3;

Returns
Type	Description
List<String>	A list containing the includeProjectIds.

getRestrictedLocations(int index)

public abstract String getRestrictedLocations(int index)

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

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The restrictedLocations at the given index.

getRestrictedLocationsBytes(int index)

public abstract ByteString getRestrictedLocationsBytes(int index)

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

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the restrictedLocations at the given index.

getRestrictedLocationsCount()

public abstract int getRestrictedLocationsCount()

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

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of restrictedLocations.

getRestrictedLocationsList()

public abstract List<String> getRestrictedLocationsList()

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

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<String>	A list containing the restrictedLocations.