Package com.google.cloud.datacatalog.v1

Class SearchCatalogRequest.Scope.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Scope.Builder>
com.google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.Builder
All Implemented Interfaces:
SearchCatalogRequest.ScopeOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchCatalogRequest.Scope
public static final class SearchCatalogRequest.Scope.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Scope.Builder> implements SearchCatalogRequest.ScopeOrBuilder
 The criteria that select the subspace used for query matching.
Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Scope.Builder>

    • clear

      public SearchCatalogRequest.Scope.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Scope.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Scope.Builder>

    • getDefaultInstanceForType

      public SearchCatalogRequest.Scope getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SearchCatalogRequest.Scope build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SearchCatalogRequest.Scope buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SearchCatalogRequest.Scope.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchCatalogRequest.Scope.Builder>

    • mergeFrom

      public SearchCatalogRequest.Scope.Builder mergeFrom(SearchCatalogRequest.Scope other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Scope.Builder>

    • mergeFrom

      public SearchCatalogRequest.Scope.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchCatalogRequest.Scope.Builder>
      Throws:
      IOException

    • getIncludeOrgIdsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getIncludeOrgIdsList in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      A list containing the includeOrgIds.

    • getIncludeOrgIdsCount

      public 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;
      Specified by:
      getIncludeOrgIdsCount in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      The count of includeOrgIds.

    • getIncludeOrgIds

      public 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;
      Specified by:
      getIncludeOrgIds in interface SearchCatalogRequest.ScopeOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The includeOrgIds at the given index.

    • getIncludeOrgIdsBytes

      public 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;
      Specified by:
      getIncludeOrgIdsBytes in interface SearchCatalogRequest.ScopeOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includeOrgIds at the given index.

    • setIncludeOrgIds

      public SearchCatalogRequest.Scope.Builder setIncludeOrgIds(int index, String value)
       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 to set the value at.
      value - The includeOrgIds to set.
      Returns:
      This builder for chaining.

    • addIncludeOrgIds

      public SearchCatalogRequest.Scope.Builder addIncludeOrgIds(String value)
       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:
      value - The includeOrgIds to add.
      Returns:
      This builder for chaining.

    • addAllIncludeOrgIds

      public SearchCatalogRequest.Scope.Builder addAllIncludeOrgIds(Iterable<String> values)
       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:
      values - The includeOrgIds to add.
      Returns:
      This builder for chaining.

    • clearIncludeOrgIds

      public SearchCatalogRequest.Scope.Builder clearIncludeOrgIds()
       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:
      This builder for chaining.

    • addIncludeOrgIdsBytes

      public SearchCatalogRequest.Scope.Builder addIncludeOrgIdsBytes(com.google.protobuf.ByteString value)
       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:
      value - The bytes of the includeOrgIds to add.
      Returns:
      This builder for chaining.

    • getIncludeProjectIdsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getIncludeProjectIdsList in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      A list containing the includeProjectIds.

    • getIncludeProjectIdsCount

      public 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;
      Specified by:
      getIncludeProjectIdsCount in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      The count of includeProjectIds.

    • getIncludeProjectIds

      public 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;
      Specified by:
      getIncludeProjectIds in interface SearchCatalogRequest.ScopeOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The includeProjectIds at the given index.

    • getIncludeProjectIdsBytes

      public 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;
      Specified by:
      getIncludeProjectIdsBytes in interface SearchCatalogRequest.ScopeOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the includeProjectIds at the given index.

    • setIncludeProjectIds

      public SearchCatalogRequest.Scope.Builder setIncludeProjectIds(int index, String value)
       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 to set the value at.
      value - The includeProjectIds to set.
      Returns:
      This builder for chaining.

    • addIncludeProjectIds

      public SearchCatalogRequest.Scope.Builder addIncludeProjectIds(String value)
       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:
      value - The includeProjectIds to add.
      Returns:
      This builder for chaining.

    • addAllIncludeProjectIds

      public SearchCatalogRequest.Scope.Builder addAllIncludeProjectIds(Iterable<String> values)
       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:
      values - The includeProjectIds to add.
      Returns:
      This builder for chaining.

    • clearIncludeProjectIds

      public SearchCatalogRequest.Scope.Builder clearIncludeProjectIds()
       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:
      This builder for chaining.

    • addIncludeProjectIdsBytes

      public SearchCatalogRequest.Scope.Builder addIncludeProjectIdsBytes(com.google.protobuf.ByteString value)
       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:
      value - The bytes of the includeProjectIds to add.
      Returns:
      This builder for chaining.

    • getIncludeGcpPublicDatasets

      public 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;
      Specified by:
      getIncludeGcpPublicDatasets in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      The includeGcpPublicDatasets.

    • setIncludeGcpPublicDatasets

      public SearchCatalogRequest.Scope.Builder setIncludeGcpPublicDatasets(boolean value)
       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;
      Parameters:
      value - The includeGcpPublicDatasets to set.
      Returns:
      This builder for chaining.

    • clearIncludeGcpPublicDatasets

      public SearchCatalogRequest.Scope.Builder clearIncludeGcpPublicDatasets()
       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:
      This builder for chaining.

    • getRestrictedLocationsList

      public com.google.protobuf.ProtocolStringList 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];
      Specified by:
      getRestrictedLocationsList in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      A list containing the restrictedLocations.

    • getRestrictedLocationsCount

      public 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];
      Specified by:
      getRestrictedLocationsCount in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      The count of restrictedLocations.

    • getRestrictedLocations

      public 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];
      Specified by:
      getRestrictedLocations in interface SearchCatalogRequest.ScopeOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The restrictedLocations at the given index.

    • getRestrictedLocationsBytes

      public 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];
      Specified by:
      getRestrictedLocationsBytes in interface SearchCatalogRequest.ScopeOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the restrictedLocations at the given index.

    • setRestrictedLocations

      public SearchCatalogRequest.Scope.Builder setRestrictedLocations(int index, String value)
       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 to set the value at.
      value - The restrictedLocations to set.
      Returns:
      This builder for chaining.

    • addRestrictedLocations

      public SearchCatalogRequest.Scope.Builder addRestrictedLocations(String value)
       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:
      value - The restrictedLocations to add.
      Returns:
      This builder for chaining.

    • addAllRestrictedLocations

      public SearchCatalogRequest.Scope.Builder addAllRestrictedLocations(Iterable<String> values)
       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:
      values - The restrictedLocations to add.
      Returns:
      This builder for chaining.

    • clearRestrictedLocations

      public SearchCatalogRequest.Scope.Builder clearRestrictedLocations()
       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:
      This builder for chaining.

    • addRestrictedLocationsBytes

      public SearchCatalogRequest.Scope.Builder addRestrictedLocationsBytes(com.google.protobuf.ByteString value)
       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:
      value - The bytes of the restrictedLocations to add.
      Returns:
      This builder for chaining.

    • getStarredOnly

      public 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];
      Specified by:
      getStarredOnly in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      The starredOnly.

    • setStarredOnly

      public SearchCatalogRequest.Scope.Builder setStarredOnly(boolean value)
       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];
      Parameters:
      value - The starredOnly to set.
      Returns:
      This builder for chaining.

    • clearStarredOnly

      public SearchCatalogRequest.Scope.Builder clearStarredOnly()
       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:
      This builder for chaining.

    • getIncludePublicTagTemplates

      @Deprecated public 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];
      Specified by:
      getIncludePublicTagTemplates in interface SearchCatalogRequest.ScopeOrBuilder
      Returns:
      The includePublicTagTemplates.

    • setIncludePublicTagTemplates

      @Deprecated public SearchCatalogRequest.Scope.Builder setIncludePublicTagTemplates(boolean value)
      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];
      Parameters:
      value - The includePublicTagTemplates to set.
      Returns:
      This builder for chaining.

    • clearIncludePublicTagTemplates

      @Deprecated public SearchCatalogRequest.Scope.Builder clearIncludePublicTagTemplates()
      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:
      This builder for chaining.