Class SendConnectorEventRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iotmanagedintegrations.model.IotManagedIntegrationsRequest
software.amazon.awssdk.services.iotmanagedintegrations.model.SendConnectorEventRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SendConnectorEventRequest.Builder,SendConnectorEventRequest>
@Generated("software.amazon.awssdk:codegen") public final class SendConnectorEventRequest extends IotManagedIntegrationsRequest implements ToCopyableBuilder<SendConnectorEventRequest.Builder,SendConnectorEventRequest>

  • Method Details

    • connectorId

      public final String connectorId()

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

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

    • userId

      public final String userId()

      The id of the third-party cloud provider.

      Returns:
      The id of the third-party cloud provider.

    • operation

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, operation will return ConnectorEventOperation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

      Returns:
      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.

      See Also:

    • operationAsString

      public final String operationAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, operation will return ConnectorEventOperation.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operationAsString().

      Returns:
      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.

      See Also:

    • operationVersion

      public final 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.

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

    • statusCode

      public final Integer statusCode()

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

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

    • message

      public final 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.

      Returns:
      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.

    • deviceDiscoveryId

      public final String deviceDiscoveryId()

      The id for the device discovery job.

      Returns:
      The id for the device discovery job.

    • connectorDeviceId

      public final 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.

      Returns:
      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.

    • traceId

      public final 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.

      Returns:
      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.

    • hasDevices

      public final boolean hasDevices()
      For responses, this returns true if the service returned a value for the Devices property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • devices

      public final List<Device> devices()

      The list of devices.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDevices() method.

      Returns:
      The list of devices.

    • matterEndpoint

      public final MatterEndpoint matterEndpoint()

      The device endpoint.

      Returns:
      The device endpoint.

    • toBuilder

      public SendConnectorEventRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SendConnectorEventRequest.Builder,SendConnectorEventRequest>
      Specified by:
      toBuilder in class IotManagedIntegrationsRequest
      Returns:
      a builder for type T

    • builder

      public static SendConnectorEventRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SendConnectorEventRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.