Package com.viam.service.motion.v1

Class Motion.MoveOnGlobeRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<Motion.MoveOnGlobeRequest,Motion.MoveOnGlobeRequest.Builder>
com.viam.service.motion.v1.Motion.MoveOnGlobeRequest.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Motion.MoveOnGlobeRequestOrBuilder, Cloneable
Enclosing class:
Motion.MoveOnGlobeRequest
public static final class Motion.MoveOnGlobeRequest.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Motion.MoveOnGlobeRequest,Motion.MoveOnGlobeRequest.Builder> implements Motion.MoveOnGlobeRequestOrBuilder
Protobuf type viam.service.motion.v1.MoveOnGlobeRequest

  • Method Details

    • getName

      public String getName()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Specified by:
      getName in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Specified by:
      getNameBytes in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Motion.MoveOnGlobeRequest.Builder setName(String value)
       Name of the motion service
      string name = 1 [json_name = "name"];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Motion.MoveOnGlobeRequest.Builder clearName()
       Name of the motion service
      string name = 1 [json_name = "name"];
      Returns:
      This builder for chaining.

    • setNameBytes

      public Motion.MoveOnGlobeRequest.Builder setNameBytes(com.google.protobuf.ByteString value)
       Name of the motion service
      string name = 1 [json_name = "name"];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • hasDestination

      public boolean hasDestination()
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];
      Specified by:
      hasDestination in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the destination field is set.

    • getDestination

      public Common.GeoPoint getDestination()
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];
      Specified by:
      getDestination in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The destination.

    • setDestination

      public Motion.MoveOnGlobeRequest.Builder setDestination(Common.GeoPoint value)
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];

    • setDestination

      public Motion.MoveOnGlobeRequest.Builder setDestination(Common.GeoPoint.Builder builderForValue)
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];

    • mergeDestination

      public Motion.MoveOnGlobeRequest.Builder mergeDestination(Common.GeoPoint value)
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];

    • clearDestination

      public Motion.MoveOnGlobeRequest.Builder clearDestination()
       Destination, encoded as a GeoPoint
      .viam.common.v1.GeoPoint destination = 2 [json_name = "destination"];

    • hasHeading

      public boolean hasHeading()
       Optional compass heading to achieve at the destination, in degrees [0-360)
      optional double heading = 3 [json_name = "heading"];
      Specified by:
      hasHeading in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the heading field is set.

    • getHeading

      public double getHeading()
       Optional compass heading to achieve at the destination, in degrees [0-360)
      optional double heading = 3 [json_name = "heading"];
      Specified by:
      getHeading in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The heading.

    • setHeading

      public Motion.MoveOnGlobeRequest.Builder setHeading(double value)
       Optional compass heading to achieve at the destination, in degrees [0-360)
      optional double heading = 3 [json_name = "heading"];
      Parameters:
      value - The heading to set.
      Returns:
      This builder for chaining.

    • clearHeading

      public Motion.MoveOnGlobeRequest.Builder clearHeading()
       Optional compass heading to achieve at the destination, in degrees [0-360)
      optional double heading = 3 [json_name = "heading"];
      Returns:
      This builder for chaining.

    • hasComponentNameDeprecated

      @Deprecated public boolean hasComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 4 [json_name = "componentNameDeprecated", deprecated = true];
      Specified by:
      hasComponentNameDeprecated in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the componentNameDeprecated field is set.

    • getComponentNameDeprecated

      @Deprecated public Common.ResourceName getComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 4 [json_name = "componentNameDeprecated", deprecated = true];
      Specified by:
      getComponentNameDeprecated in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The componentNameDeprecated.

    • setComponentNameDeprecated

      @Deprecated public Motion.MoveOnGlobeRequest.Builder setComponentNameDeprecated(Common.ResourceName value)
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 4 [json_name = "componentNameDeprecated", deprecated = true];

    • setComponentNameDeprecated

      @Deprecated public Motion.MoveOnGlobeRequest.Builder setComponentNameDeprecated(Common.ResourceName.Builder builderForValue)
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 4 [json_name = "componentNameDeprecated", deprecated = true];

    • mergeComponentNameDeprecated

      @Deprecated public Motion.MoveOnGlobeRequest.Builder mergeComponentNameDeprecated(Common.ResourceName value)
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 4 [json_name = "componentNameDeprecated", deprecated = true];

    • clearComponentNameDeprecated

      @Deprecated public Motion.MoveOnGlobeRequest.Builder clearComponentNameDeprecated()
      Deprecated.
       Deprecated, use component_name field.
      .viam.common.v1.ResourceName component_name_deprecated = 4 [json_name = "componentNameDeprecated", deprecated = true];

    • hasMovementSensorNameDeprecated

      @Deprecated public boolean hasMovementSensorNameDeprecated()
      Deprecated.
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];
      Specified by:
      hasMovementSensorNameDeprecated in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the movementSensorNameDeprecated field is set.

    • getMovementSensorNameDeprecated

      @Deprecated public Common.ResourceName getMovementSensorNameDeprecated()
      Deprecated.
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];
      Specified by:
      getMovementSensorNameDeprecated in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The movementSensorNameDeprecated.

    • setMovementSensorNameDeprecated

      @Deprecated public Motion.MoveOnGlobeRequest.Builder setMovementSensorNameDeprecated(Common.ResourceName value)
      Deprecated.
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];

    • setMovementSensorNameDeprecated

      @Deprecated public Motion.MoveOnGlobeRequest.Builder setMovementSensorNameDeprecated(Common.ResourceName.Builder builderForValue)
      Deprecated.
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];

    • mergeMovementSensorNameDeprecated

      @Deprecated public Motion.MoveOnGlobeRequest.Builder mergeMovementSensorNameDeprecated(Common.ResourceName value)
      Deprecated.
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];

    • clearMovementSensorNameDeprecated

      @Deprecated public Motion.MoveOnGlobeRequest.Builder clearMovementSensorNameDeprecated()
      Deprecated.
       Deprecated, use movement_sensor_name field.
      .viam.common.v1.ResourceName movement_sensor_name_deprecated = 5 [json_name = "movementSensorNameDeprecated", deprecated = true];

    • getObstaclesList

      public List<Common.GeoGeometry> getObstaclesList()
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];
      Specified by:
      getObstaclesList in interface Motion.MoveOnGlobeRequestOrBuilder

    • getObstaclesCount

      public int getObstaclesCount()
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];
      Specified by:
      getObstaclesCount in interface Motion.MoveOnGlobeRequestOrBuilder

    • getObstacles

      public Common.GeoGeometry getObstacles(int index)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];
      Specified by:
      getObstacles in interface Motion.MoveOnGlobeRequestOrBuilder

    • setObstacles

      public Motion.MoveOnGlobeRequest.Builder setObstacles(int index, Common.GeoGeometry value)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • setObstacles

      public Motion.MoveOnGlobeRequest.Builder setObstacles(int index, Common.GeoGeometry.Builder builderForValue)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • addObstacles

      public Motion.MoveOnGlobeRequest.Builder addObstacles(Common.GeoGeometry value)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • addObstacles

      public Motion.MoveOnGlobeRequest.Builder addObstacles(int index, Common.GeoGeometry value)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • addObstacles

      public Motion.MoveOnGlobeRequest.Builder addObstacles(Common.GeoGeometry.Builder builderForValue)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • addObstacles

      public Motion.MoveOnGlobeRequest.Builder addObstacles(int index, Common.GeoGeometry.Builder builderForValue)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • addAllObstacles

      public Motion.MoveOnGlobeRequest.Builder addAllObstacles(Iterable<? extends Common.GeoGeometry> values)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • clearObstacles

      public Motion.MoveOnGlobeRequest.Builder clearObstacles()
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • removeObstacles

      public Motion.MoveOnGlobeRequest.Builder removeObstacles(int index)
       Obstacles to be considered for motion planning
      repeated .viam.common.v1.GeoGeometry obstacles = 6 [json_name = "obstacles"];

    • hasMotionConfiguration

      public boolean hasMotionConfiguration()
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 7 [json_name = "motionConfiguration"];
      Specified by:
      hasMotionConfiguration in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the motionConfiguration field is set.

    • getMotionConfiguration

      public Motion.MotionConfiguration getMotionConfiguration()
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 7 [json_name = "motionConfiguration"];
      Specified by:
      getMotionConfiguration in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The motionConfiguration.

    • setMotionConfiguration

      public Motion.MoveOnGlobeRequest.Builder setMotionConfiguration(Motion.MotionConfiguration value)
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 7 [json_name = "motionConfiguration"];

    • setMotionConfiguration

      public Motion.MoveOnGlobeRequest.Builder setMotionConfiguration(Motion.MotionConfiguration.Builder builderForValue)
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 7 [json_name = "motionConfiguration"];

    • mergeMotionConfiguration

      public Motion.MoveOnGlobeRequest.Builder mergeMotionConfiguration(Motion.MotionConfiguration value)
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 7 [json_name = "motionConfiguration"];

    • clearMotionConfiguration

      public Motion.MoveOnGlobeRequest.Builder clearMotionConfiguration()
       Optional set of motion configuration options
      optional .viam.service.motion.v1.MotionConfiguration motion_configuration = 7 [json_name = "motionConfiguration"];

    • getBoundingRegionsList

      public List<Common.GeoGeometry> getBoundingRegionsList()
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];
      Specified by:
      getBoundingRegionsList in interface Motion.MoveOnGlobeRequestOrBuilder

    • getBoundingRegionsCount

      public int getBoundingRegionsCount()
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];
      Specified by:
      getBoundingRegionsCount in interface Motion.MoveOnGlobeRequestOrBuilder

    • getBoundingRegions

      public Common.GeoGeometry getBoundingRegions(int index)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];
      Specified by:
      getBoundingRegions in interface Motion.MoveOnGlobeRequestOrBuilder

    • setBoundingRegions

      public Motion.MoveOnGlobeRequest.Builder setBoundingRegions(int index, Common.GeoGeometry value)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • setBoundingRegions

      public Motion.MoveOnGlobeRequest.Builder setBoundingRegions(int index, Common.GeoGeometry.Builder builderForValue)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • addBoundingRegions

      public Motion.MoveOnGlobeRequest.Builder addBoundingRegions(Common.GeoGeometry value)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • addBoundingRegions

      public Motion.MoveOnGlobeRequest.Builder addBoundingRegions(int index, Common.GeoGeometry value)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • addBoundingRegions

      public Motion.MoveOnGlobeRequest.Builder addBoundingRegions(Common.GeoGeometry.Builder builderForValue)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • addBoundingRegions

      public Motion.MoveOnGlobeRequest.Builder addBoundingRegions(int index, Common.GeoGeometry.Builder builderForValue)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • addAllBoundingRegions

      public Motion.MoveOnGlobeRequest.Builder addAllBoundingRegions(Iterable<? extends Common.GeoGeometry> values)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • clearBoundingRegions

      public Motion.MoveOnGlobeRequest.Builder clearBoundingRegions()
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • removeBoundingRegions

      public Motion.MoveOnGlobeRequest.Builder removeBoundingRegions(int index)
       Set of obstacles which the robot must remain within while navigating
      repeated .viam.common.v1.GeoGeometry bounding_regions = 8 [json_name = "boundingRegions"];

    • getComponentName

      public String getComponentName()
       Component on the robot to move to the specified destination
      string component_name = 9 [json_name = "componentName"];
      Specified by:
      getComponentName in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The componentName.

    • getComponentNameBytes

      public com.google.protobuf.ByteString getComponentNameBytes()
       Component on the robot to move to the specified destination
      string component_name = 9 [json_name = "componentName"];
      Specified by:
      getComponentNameBytes in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The bytes for componentName.

    • setComponentName

      public Motion.MoveOnGlobeRequest.Builder setComponentName(String value)
       Component on the robot to move to the specified destination
      string component_name = 9 [json_name = "componentName"];
      Parameters:
      value - The componentName to set.
      Returns:
      This builder for chaining.

    • clearComponentName

      public Motion.MoveOnGlobeRequest.Builder clearComponentName()
       Component on the robot to move to the specified destination
      string component_name = 9 [json_name = "componentName"];
      Returns:
      This builder for chaining.

    • setComponentNameBytes

      public Motion.MoveOnGlobeRequest.Builder setComponentNameBytes(com.google.protobuf.ByteString value)
       Component on the robot to move to the specified destination
      string component_name = 9 [json_name = "componentName"];
      Parameters:
      value - The bytes for componentName to set.
      Returns:
      This builder for chaining.

    • getMovementSensorName

      public String getMovementSensorName()
       Name of the movement sensor which will be used to check robot location
      string movement_sensor_name = 10 [json_name = "movementSensorName"];
      Specified by:
      getMovementSensorName in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The movementSensorName.

    • getMovementSensorNameBytes

      public com.google.protobuf.ByteString getMovementSensorNameBytes()
       Name of the movement sensor which will be used to check robot location
      string movement_sensor_name = 10 [json_name = "movementSensorName"];
      Specified by:
      getMovementSensorNameBytes in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The bytes for movementSensorName.

    • setMovementSensorName

      public Motion.MoveOnGlobeRequest.Builder setMovementSensorName(String value)
       Name of the movement sensor which will be used to check robot location
      string movement_sensor_name = 10 [json_name = "movementSensorName"];
      Parameters:
      value - The movementSensorName to set.
      Returns:
      This builder for chaining.

    • clearMovementSensorName

      public Motion.MoveOnGlobeRequest.Builder clearMovementSensorName()
       Name of the movement sensor which will be used to check robot location
      string movement_sensor_name = 10 [json_name = "movementSensorName"];
      Returns:
      This builder for chaining.

    • setMovementSensorNameBytes

      public Motion.MoveOnGlobeRequest.Builder setMovementSensorNameBytes(com.google.protobuf.ByteString value)
       Name of the movement sensor which will be used to check robot location
      string movement_sensor_name = 10 [json_name = "movementSensorName"];
      Parameters:
      value - The bytes for movementSensorName to set.
      Returns:
      This builder for chaining.

    • hasExtra

      public boolean hasExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Specified by:
      hasExtra in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      Whether the extra field is set.

    • getExtra

      public com.google.protobuf.Struct getExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];
      Specified by:
      getExtra in interface Motion.MoveOnGlobeRequestOrBuilder
      Returns:
      The extra.

    • setExtra

      public Motion.MoveOnGlobeRequest.Builder setExtra(com.google.protobuf.Struct value)
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];

    • setExtra

      public Motion.MoveOnGlobeRequest.Builder setExtra(com.google.protobuf.Struct.Builder builderForValue)
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];

    • mergeExtra

      public Motion.MoveOnGlobeRequest.Builder mergeExtra(com.google.protobuf.Struct value)
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];

    • clearExtra

      public Motion.MoveOnGlobeRequest.Builder clearExtra()
       Additional arguments to the method
      .google.protobuf.Struct extra = 99 [json_name = "extra"];