Interface ControlOperation.Builder

  • Method Details

    • controlIdentifier

      ControlOperation.Builder controlIdentifier(String controlIdentifier)

      The controlIdentifier of the control for the operation.

      Parameters:
      controlIdentifier - The controlIdentifier of the control for the operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • enabledControlIdentifier

      ControlOperation.Builder enabledControlIdentifier(String enabledControlIdentifier)

      The controlIdentifier of the enabled control.

      Parameters:
      enabledControlIdentifier - The controlIdentifier of the enabled control.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endTime

      The time that the operation finished.

      Parameters:
      endTime - The time that the operation finished.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • operationIdentifier

      ControlOperation.Builder operationIdentifier(String operationIdentifier)

      The identifier of the specified operation.

      Parameters:
      operationIdentifier - The identifier of the specified operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • operationType

      ControlOperation.Builder operationType(String operationType)

      One of ENABLE_CONTROL or DISABLE_CONTROL.

      Parameters:
      operationType - One of ENABLE_CONTROL or DISABLE_CONTROL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • operationType

      ControlOperation.Builder operationType(ControlOperationType operationType)

      One of ENABLE_CONTROL or DISABLE_CONTROL.

      Parameters:
      operationType - One of ENABLE_CONTROL or DISABLE_CONTROL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • startTime

      ControlOperation.Builder startTime(Instant startTime)

      The time that the operation began.

      Parameters:
      startTime - The time that the operation began.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      One of IN_PROGRESS, SUCEEDED, or FAILED.

      Parameters:
      status - One of IN_PROGRESS, SUCEEDED, or FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      One of IN_PROGRESS, SUCEEDED, or FAILED.

      Parameters:
      status - One of IN_PROGRESS, SUCEEDED, or FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • statusMessage

      ControlOperation.Builder statusMessage(String statusMessage)

      If the operation result is FAILED, this string contains a message explaining why the operation failed.

      Parameters:
      statusMessage - If the operation result is FAILED, this string contains a message explaining why the operation failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • targetIdentifier

      ControlOperation.Builder targetIdentifier(String targetIdentifier)

      The target upon which the control operation is working.

      Parameters:
      targetIdentifier - The target upon which the control operation is working.
      Returns:
      Returns a reference to this object so that method calls can be chained together.