Package viam.app.v1

Interface AppOuterClass.ListMachineSummariesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
AppOuterClass.ListMachineSummariesRequest, AppOuterClass.ListMachineSummariesRequest.Builder
Enclosing class:
AppOuterClass
public static interface AppOuterClass.ListMachineSummariesRequestOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFragmentIds(int index)
    Optional list of fragment IDs to filter machines that use any of these fragments
    com.google.protobuf.ByteString
    getFragmentIdsBytes(int index)
    Optional list of fragment IDs to filter machines that use any of these fragments
    int
    getFragmentIdsCount()
    Optional list of fragment IDs to filter machines that use any of these fragments
    List<String>
    getFragmentIdsList()
    Optional list of fragment IDs to filter machines that use any of these fragments
    int
    getLimit()
    Optional max number of machines to return; default to 100 if unset
    String
    getLocationIds(int index)
    Optional list of location IDs to filter machines that are in any of these locations.
    com.google.protobuf.ByteString
    getLocationIdsBytes(int index)
    Optional list of location IDs to filter machines that are in any of these locations.
    int
    getLocationIdsCount()
    Optional list of location IDs to filter machines that are in any of these locations.
    List<String>
    getLocationIdsList()
    Optional list of location IDs to filter machines that are in any of these locations.
    String
    getOrganizationId()
    Optional organization ID.
    com.google.protobuf.ByteString
    getOrganizationIdBytes()
    Optional organization ID.
    boolean
    hasLimit()
    Optional max number of machines to return; default to 100 if unset

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getOrganizationId

      String getOrganizationId()
       Optional organization ID. If no value is set it will search among all the organanizations the caller has access to
      string organization_id = 1 [json_name = "organizationId"];
      Returns:
      The organizationId.

    • getOrganizationIdBytes

      com.google.protobuf.ByteString getOrganizationIdBytes()
       Optional organization ID. If no value is set it will search among all the organanizations the caller has access to
      string organization_id = 1 [json_name = "organizationId"];
      Returns:
      The bytes for organizationId.

    • getFragmentIdsList

      List<String> getFragmentIdsList()
       Optional list of fragment IDs to filter machines that use any of these fragments
      repeated string fragment_ids = 2 [json_name = "fragmentIds"];
      Returns:
      A list containing the fragmentIds.

    • getFragmentIdsCount

      int getFragmentIdsCount()
       Optional list of fragment IDs to filter machines that use any of these fragments
      repeated string fragment_ids = 2 [json_name = "fragmentIds"];
      Returns:
      The count of fragmentIds.

    • getFragmentIds

      String getFragmentIds(int index)
       Optional list of fragment IDs to filter machines that use any of these fragments
      repeated string fragment_ids = 2 [json_name = "fragmentIds"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The fragmentIds at the given index.

    • getFragmentIdsBytes

      com.google.protobuf.ByteString getFragmentIdsBytes(int index)
       Optional list of fragment IDs to filter machines that use any of these fragments
      repeated string fragment_ids = 2 [json_name = "fragmentIds"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The fragmentIds at the given index.

    • getLocationIdsList

      List<String> getLocationIdsList()
       Optional list of location IDs to filter machines that are in any of these locations.
      repeated string location_ids = 3 [json_name = "locationIds"];
      Returns:
      A list containing the locationIds.

    • getLocationIdsCount

      int getLocationIdsCount()
       Optional list of location IDs to filter machines that are in any of these locations.
      repeated string location_ids = 3 [json_name = "locationIds"];
      Returns:
      The count of locationIds.

    • getLocationIds

      String getLocationIds(int index)
       Optional list of location IDs to filter machines that are in any of these locations.
      repeated string location_ids = 3 [json_name = "locationIds"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The locationIds at the given index.

    • getLocationIdsBytes

      com.google.protobuf.ByteString getLocationIdsBytes(int index)
       Optional list of location IDs to filter machines that are in any of these locations.
      repeated string location_ids = 3 [json_name = "locationIds"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The locationIds at the given index.

    • hasLimit

      boolean hasLimit()
       Optional max number of machines to return; default to 100 if unset
      optional int32 limit = 4 [json_name = "limit"];
      Returns:
      Whether the limit field is set.

    • getLimit

      int getLimit()
       Optional max number of machines to return; default to 100 if unset
      optional int32 limit = 4 [json_name = "limit"];
      Returns:
      The limit.