public static interface SearchCatalogRequest.ScopeOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
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.
- If empty, search will be performed in all locations;
- If any of the locations are NOT in the valid locations list, error will be returned;
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.
- If empty, search will be performed in all locations;
- If any of the locations are NOT in the valid locations list, error will be returned;
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.
- If empty, search will be performed in all locations;
- If any of the locations are NOT in the valid locations list, error will be returned;
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.
- If empty, search will be performed in all locations;
- If any of the locations are NOT in the valid locations list, error will be returned;
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. |