Interface SendConnectorEventRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SendConnectorEventRequest.Builder,SendConnectorEventRequest>, IotManagedIntegrationsRequest.Builder, SdkBuilder<SendConnectorEventRequest.Builder,SendConnectorEventRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SendConnectorEventRequest
@Mutable @NotThreadSafe public static interface SendConnectorEventRequest.Builder extends IotManagedIntegrationsRequest.Builder, SdkPojo, CopyableBuilder<SendConnectorEventRequest.Builder,SendConnectorEventRequest>

  • Method Details

    • connectorId

      SendConnectorEventRequest.Builder connectorId(String connectorId)

      The id of the connector between the third-party cloud provider and IoT managed integrations.

      Parameters:
      connectorId - The id of the connector between the third-party cloud provider and IoT managed integrations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      SendConnectorEventRequest.Builder userId(String userId)

      The id of the third-party cloud provider.

      Parameters:
      userId - The id of the third-party cloud provider.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operation

      SendConnectorEventRequest.Builder operation(String operation)

      The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.

      The field op can have a value of "I" or "U". The field "cn" will contain the capability types.

      Parameters:
      operation - The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.

      The field op can have a value of "I" or "U". The field "cn" will contain the capability types.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • operation

      SendConnectorEventRequest.Builder operation(ConnectorEventOperation operation)

      The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.

      The field op can have a value of "I" or "U". The field "cn" will contain the capability types.

      Parameters:
      operation - The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.

      The field op can have a value of "I" or "U". The field "cn" will contain the capability types.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • operationVersion

      SendConnectorEventRequest.Builder operationVersion(String operationVersion)

      The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.

      Parameters:
      operationVersion - The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusCode

      SendConnectorEventRequest.Builder statusCode(Integer statusCode)

      The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.

      Parameters:
      statusCode - The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • message

      SendConnectorEventRequest.Builder message(String message)

      The device state change event payload.

      This parameter will include the following three fields:

      • uri: schema auc://<PARTNER-DEVICE-ID>/ResourcePath (The Resourcepath corresponds to an OCF resource.)

      • op: For device state changes, this field must populate as n+d.

      • cn: The content depends on the OCF resource referenced in ResourcePath.

      Parameters:
      message - The device state change event payload.

      This parameter will include the following three fields:

      • uri: schema auc://<PARTNER-DEVICE-ID>/ResourcePath (The Resourcepath corresponds to an OCF resource.)

      • op: For device state changes, this field must populate as n+d.

      • cn: The content depends on the OCF resource referenced in ResourcePath.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceDiscoveryId

      SendConnectorEventRequest.Builder deviceDiscoveryId(String deviceDiscoveryId)

      The id for the device discovery job.

      Parameters:
      deviceDiscoveryId - The id for the device discovery job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectorDeviceId

      SendConnectorEventRequest.Builder connectorDeviceId(String connectorDeviceId)

      The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).

      This parameter is used for cloud-to-cloud devices only.

      Parameters:
      connectorDeviceId - The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).

      This parameter is used for cloud-to-cloud devices only.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • traceId

      SendConnectorEventRequest.Builder traceId(String traceId)

      The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.

      Parameters:
      traceId - The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • devices

      SendConnectorEventRequest.Builder devices(Collection<Device> devices)

      The list of devices.

      Parameters:
      devices - The list of devices.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • devices

      SendConnectorEventRequest.Builder devices(Device... devices)

      The list of devices.

      Parameters:
      devices - The list of devices.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • devices

      SendConnectorEventRequest.Builder devices(Consumer<Device.Builder>... devices)

      The list of devices.

      This is a convenience method that creates an instance of the Device.Builder avoiding the need to create one manually via Device.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to devices(List<Device>).

      Parameters:
      devices - a consumer that will call methods on Device.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • matterEndpoint

      SendConnectorEventRequest.Builder matterEndpoint(MatterEndpoint matterEndpoint)

      The device endpoint.

      Parameters:
      matterEndpoint - The device endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • matterEndpoint

      default SendConnectorEventRequest.Builder matterEndpoint(Consumer<MatterEndpoint.Builder> matterEndpoint)

      The device endpoint.

      This is a convenience method that creates an instance of the MatterEndpoint.Builder avoiding the need to create one manually via MatterEndpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to matterEndpoint(MatterEndpoint).

      Parameters:
      matterEndpoint - a consumer that will call methods on MatterEndpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      SendConnectorEventRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SendConnectorEventRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.