com.google.cloud.datacatalog.v1beta1

Interface SearchCatalogRequest.ScopeOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchCatalogRequest.Scope, SearchCatalogRequest.Scope.Builder

Enclosing class:

SearchCatalogRequest

public static interface SearchCatalogRequest.ScopeOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getIncludeGcpPublicDatasets() If `true`, include Google Cloud public datasets in the search results.
String	getIncludeOrgIds(int index) The list of organization IDs to search within.
com.google.protobuf.ByteString	getIncludeOrgIdsBytes(int index) The list of organization IDs to search within.
int	getIncludeOrgIdsCount() The list of organization IDs to search within.
List<String>	getIncludeOrgIdsList() The list of organization IDs to search within.
String	getIncludeProjectIds(int index) The list of project IDs to search within.
com.google.protobuf.ByteString	getIncludeProjectIdsBytes(int index) The list of project IDs to search within.
int	getIncludeProjectIdsCount() The list of project IDs to search within.
List<String>	getIncludeProjectIdsList() The list of project IDs to search within.
String	getRestrictedLocations(int index) Optional.
com.google.protobuf.ByteString	getRestrictedLocationsBytes(int index) Optional.
int	getRestrictedLocationsCount() Optional.
List<String>	getRestrictedLocationsList() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getIncludeOrgIdsList

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:

A list containing the includeOrgIds.

getIncludeOrgIdsCount

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:

The count of includeOrgIds.

getIncludeOrgIds

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;

Parameters:

index - The index of the element to return.

Returns:

The includeOrgIds at the given index.

getIncludeOrgIdsBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the includeOrgIds at the given index.

getIncludeProjectIdsList

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:

A list containing the includeProjectIds.

getIncludeProjectIdsCount

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:

The count of includeProjectIds.

getIncludeProjectIds

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;

Parameters:

index - The index of the element to return.

Returns:

The includeProjectIds at the given index.

getIncludeProjectIdsBytes

com.google.protobuf.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;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the includeProjectIds at the given index.

getIncludeGcpPublicDatasets

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:

The includeGcpPublicDatasets.

getRestrictedLocationsList

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:

A list containing the restrictedLocations.

getRestrictedLocationsCount

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:

The count of restrictedLocations.

getRestrictedLocations

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];

Parameters:

index - The index of the element to return.

Returns:

The restrictedLocations at the given index.

getRestrictedLocationsBytes

com.google.protobuf.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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the restrictedLocations at the given index.