Class SearchAllResourcesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.asset.v1p1beta1.SearchAllResourcesRequest
All Implemented Interfaces:
SearchAllResourcesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class SearchAllResourcesRequest extends com.google.protobuf.GeneratedMessage implements SearchAllResourcesRequestOrBuilder
 Search all resources request.
 
Protobuf type google.cloud.asset.v1p1beta1.SearchAllResourcesRequest
See Also:
  • Field Details

  • 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
    • getScope

      public 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];
      Specified by:
      getScope in interface SearchAllResourcesRequestOrBuilder
      Returns:
      The scope.
    • getScopeBytes

      public 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];
      Specified by:
      getScopeBytes in interface SearchAllResourcesRequestOrBuilder
      Returns:
      The bytes for scope.
    • getQuery

      public String getQuery()
       Optional. The query statement.
       
      string query = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQuery in interface SearchAllResourcesRequestOrBuilder
      Returns:
      The query.
    • getQueryBytes

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

      public com.google.protobuf.ProtocolStringList 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];
      Specified by:
      getAssetTypesList in interface SearchAllResourcesRequestOrBuilder
      Returns:
      A list containing the assetTypes.
    • getAssetTypesCount

      public 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];
      Specified by:
      getAssetTypesCount in interface SearchAllResourcesRequestOrBuilder
      Returns:
      The count of assetTypes.
    • getAssetTypes

      public 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];
      Specified by:
      getAssetTypes in interface SearchAllResourcesRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The assetTypes at the given index.
    • getAssetTypesBytes

      public 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];
      Specified by:
      getAssetTypesBytes in interface SearchAllResourcesRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the assetTypes at the given index.
    • getPageSize

      public 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];
      Specified by:
      getPageSize in interface SearchAllResourcesRequestOrBuilder
      Returns:
      The pageSize.
    • getPageToken

      public 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];
      Specified by:
      getPageToken in interface SearchAllResourcesRequestOrBuilder
      Returns:
      The pageToken.
    • getPageTokenBytes

      public 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];
      Specified by:
      getPageTokenBytes in interface SearchAllResourcesRequestOrBuilder
      Returns:
      The bytes for pageToken.
    • getOrderBy

      public 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];
      Specified by:
      getOrderBy in interface SearchAllResourcesRequestOrBuilder
      Returns:
      The orderBy.
    • getOrderByBytes

      public 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];
      Specified by:
      getOrderByBytes in interface SearchAllResourcesRequestOrBuilder
      Returns:
      The bytes for orderBy.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchAllResourcesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchAllResourcesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchAllResourcesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public SearchAllResourcesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static SearchAllResourcesRequest.Builder newBuilder()
    • newBuilder

      public static SearchAllResourcesRequest.Builder newBuilder(SearchAllResourcesRequest prototype)
    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected SearchAllResourcesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static SearchAllResourcesRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<SearchAllResourcesRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<SearchAllResourcesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

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