Interface SearchAllResourcesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SearchAllResourcesRequest, SearchAllResourcesRequest.Builder

    public interface SearchAllResourcesRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getScope

        String getScope()
         Required. The relative name of an asset. The search is limited to the
         resources within the `scope`. The allowed value must be:
        
         * Organization number (such as "organizations/123")
         * Folder number (such as "folders/1234")
         * Project number (such as "projects/12345")
         * Project ID (such as "projects/abc")
         
        string scope = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The scope.
      • getScopeBytes

        com.google.protobuf.ByteString getScopeBytes()
         Required. The relative name of an asset. The search is limited to the
         resources within the `scope`. The allowed value must be:
        
         * Organization number (such as "organizations/123")
         * Folder number (such as "folders/1234")
         * Project number (such as "projects/12345")
         * Project ID (such as "projects/abc")
         
        string scope = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for scope.
      • getQuery

        String getQuery()
         Optional. The query statement.
         
        string query = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The query.
      • getQueryBytes

        com.google.protobuf.ByteString getQueryBytes()
         Optional. The query statement.
         
        string query = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for query.
      • getAssetTypesList

        List<String> getAssetTypesList()
         Optional. A list of asset types that this request searches for. If empty,
         it will search all the supported asset types.
         
        repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the assetTypes.
      • getAssetTypesCount

        int getAssetTypesCount()
         Optional. A list of asset types that this request searches for. If empty,
         it will search all the supported asset types.
         
        repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of assetTypes.
      • getAssetTypes

        String getAssetTypes​(int index)
         Optional. A list of asset types that this request searches for. If empty,
         it will search all the supported asset types.
         
        repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The assetTypes at the given index.
      • getAssetTypesBytes

        com.google.protobuf.ByteString getAssetTypesBytes​(int index)
         Optional. A list of asset types that this request searches for. If empty,
         it will search all the supported asset types.
         
        repeated string asset_types = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the assetTypes at the given index.
      • getPageSize

        int getPageSize()
         Optional. The page size for search result pagination. Page size is capped
         at 500 even if a larger value is given. If set to zero, server will pick an
         appropriate default. Returned results may be fewer than requested. When
         this happens, there could be more results as long as `next_page_token` is
         returned.
         
        int32 page_size = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageSize.
      • getPageToken

        String getPageToken()
         Optional. If present, then retrieve the next batch of results from the
         preceding call to this method.  `page_token` must be the value of
         `next_page_token` from the previous response. The values of all other
         method parameters, must be identical to those in the previous call.
         
        string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageToken.
      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         Optional. If present, then retrieve the next batch of results from the
         preceding call to this method.  `page_token` must be the value of
         `next_page_token` from the previous response. The values of all other
         method parameters, must be identical to those in the previous call.
         
        string page_token = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for pageToken.
      • getOrderBy

        String getOrderBy()
         Optional. A comma separated list of fields specifying the sorting order of
         the results. The default order is ascending. Add ` DESC` after the field
         name to indicate descending order. Redundant space characters are ignored.
         For example, `  location DESC ,  name  `.
         
        string order_by = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The orderBy.
      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         Optional. A comma separated list of fields specifying the sorting order of
         the results. The default order is ascending. Add ` DESC` after the field
         name to indicate descending order. Redundant space characters are ignored.
         For example, `  location DESC ,  name  `.
         
        string order_by = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for orderBy.