Class SetStatusRequest

    • Constructor Detail

      • SetStatusRequest

        public SetStatusRequest()
    • Method Detail

      • setPipelineId

        public void setPipelineId​(String pipelineId)

        The ID of the pipeline that contains the objects.

        Parameters:
        pipelineId - The ID of the pipeline that contains the objects.
      • getPipelineId

        public String getPipelineId()

        The ID of the pipeline that contains the objects.

        Returns:
        The ID of the pipeline that contains the objects.
      • withPipelineId

        public SetStatusRequest withPipelineId​(String pipelineId)

        The ID of the pipeline that contains the objects.

        Parameters:
        pipelineId - The ID of the pipeline that contains the objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getObjectIds

        public List<String> getObjectIds()

        The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

        Returns:
        The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
      • setObjectIds

        public void setObjectIds​(Collection<String> objectIds)

        The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

        Parameters:
        objectIds - The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
      • withObjectIds

        public SetStatusRequest withObjectIds​(String... objectIds)

        The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

        NOTE: This method appends the values to the existing list (if any). Use setObjectIds(java.util.Collection) or withObjectIds(java.util.Collection) if you want to override the existing values.

        Parameters:
        objectIds - The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withObjectIds

        public SetStatusRequest withObjectIds​(Collection<String> objectIds)

        The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

        Parameters:
        objectIds - The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setStatus

        public void setStatus​(String status)

        The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

        Parameters:
        status - The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.
      • getStatus

        public String getStatus()

        The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

        Returns:
        The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.
      • withStatus

        public SetStatusRequest withStatus​(String status)

        The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

        Parameters:
        status - The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object