Package com.google.cloud.datacatalog.v1

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 Details

    • getIncludeOrgIdsList

      List<String> getIncludeOrgIdsList()
       The list of organization IDs to search within.

 To find your organization ID, follow the steps from
 [Creating and managing organizations]
 (/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 the steps from
 [Creating and managing organizations]
 (/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 the steps from
 [Creating and managing organizations]
 (/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 the steps from
 [Creating and managing organizations]
 (/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.

 For more information on the distinction between project names, IDs, and
 numbers, see [Projects](/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.

 For more information on the distinction between project names, IDs, and
 numbers, see [Projects](/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.

 For more information on the distinction between project names, IDs, and
 numbers, see [Projects](/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.

 For more information on the distinction between project names, IDs, and
 numbers, see [Projects](/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
 search results. By default, they are excluded.

 See [Google Cloud Public Datasets](/public-datasets) for more
 information.
      bool include_gcp_public_datasets = 7;
      Returns:
      The includeGcpPublicDatasets.

    • getRestrictedLocationsList

      List<String> getRestrictedLocationsList()
       Optional. The list of locations to search within. If empty, all locations
 are searched.

 Returns an error if any location in the list isn't one of the [Supported
 regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).

 If a location is unreachable, its name is returned in the
 `SearchCatalogResponse.unreachable` field. To get additional information
 on the error, repeat the search request and set the location name as the
 value of this parameter.
      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. If empty, all locations
 are searched.

 Returns an error if any location in the list isn't one of the [Supported
 regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).

 If a location is unreachable, its name is returned in the
 `SearchCatalogResponse.unreachable` field. To get additional information
 on the error, repeat the search request and set the location name as the
 value of this parameter.
      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. If empty, all locations
 are searched.

 Returns an error if any location in the list isn't one of the [Supported
 regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).

 If a location is unreachable, its name is returned in the
 `SearchCatalogResponse.unreachable` field. To get additional information
 on the error, repeat the search request and set the location name as the
 value of this parameter.
      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. If empty, all locations
 are searched.

 Returns an error if any location in the list isn't one of the [Supported
 regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).

 If a location is unreachable, its name is returned in the
 `SearchCatalogResponse.unreachable` field. To get additional information
 on the error, repeat the search request and set the location name as the
 value of this parameter.
      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.

    • getStarredOnly

      boolean getStarredOnly()
       Optional. If `true`, search only among starred entries.

 By default, all results are returned, starred or not.
      bool starred_only = 18 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The starredOnly.

    • getIncludePublicTagTemplates

      @Deprecated boolean getIncludePublicTagTemplates()
      Deprecated.
      google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.include_public_tag_templates is deprecated. See google/cloud/datacatalog/v1/datacatalog.proto;l=754
       Optional. This field is deprecated. The search mechanism for public and
 private tag templates is the same.
      bool include_public_tag_templates = 19 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      The includePublicTagTemplates.