Class CreateConnectionRequest

    • Method Detail

      • globalNetworkId

        public final String globalNetworkId()

        The ID of the global network.

        Returns:
        The ID of the global network.
      • deviceId

        public final String deviceId()

        The ID of the first device in the connection.

        Returns:
        The ID of the first device in the connection.
      • connectedDeviceId

        public final String connectedDeviceId()

        The ID of the second device in the connection.

        Returns:
        The ID of the second device in the connection.
      • linkId

        public final String linkId()

        The ID of the link for the first device.

        Returns:
        The ID of the link for the first device.
      • connectedLinkId

        public final String connectedLinkId()

        The ID of the link for the second device.

        Returns:
        The ID of the link for the second device.
      • description

        public final String description()

        A description of the connection.

        Length Constraints: Maximum length of 256 characters.

        Returns:
        A description of the connection.

        Length Constraints: Maximum length of 256 characters.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.
      • tags

        public final List<Tag> tags()

        The tags to apply to the resource during creation.

        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 hasTags() method.

        Returns:
        The tags to apply to the resource during creation.
      • 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