Class RegisterConnectionTypeRequest

    • Method Detail

      • connectionType

        public final String connectionType()

        The name of the connection type. Must be between 1 and 255 characters and must be prefixed with "REST-" to indicate it is a REST-based connector.

        Returns:
        The name of the connection type. Must be between 1 and 255 characters and must be prefixed with "REST-" to indicate it is a REST-based connector.
      • integrationType

        public final IntegrationType integrationType()

        The integration type for the connection. Currently only "REST" protocol is supported.

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

        Returns:
        The integration type for the connection. Currently only "REST" protocol is supported.
        See Also:
        IntegrationType
      • integrationTypeAsString

        public final String integrationTypeAsString()

        The integration type for the connection. Currently only "REST" protocol is supported.

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

        Returns:
        The integration type for the connection. Currently only "REST" protocol is supported.
        See Also:
        IntegrationType
      • description

        public final String description()

        A description of the connection type. Can be up to 2048 characters and provides details about the purpose and functionality of the connection type.

        Returns:
        A description of the connection type. Can be up to 2048 characters and provides details about the purpose and functionality of the connection type.
      • connectionProperties

        public final ConnectionPropertiesConfiguration connectionProperties()

        Defines the base URL and additional request parameters needed during connection creation for this connection type.

        Returns:
        Defines the base URL and additional request parameters needed during connection creation for this connection type.
      • connectorAuthenticationConfiguration

        public final ConnectorAuthenticationConfiguration connectorAuthenticationConfiguration()

        Defines the supported authentication types and required properties for this connection type, including Basic, OAuth2, and Custom authentication methods.

        Returns:
        Defines the supported authentication types and required properties for this connection type, including Basic, OAuth2, and Custom authentication methods.
      • restConfiguration

        public final RestConfiguration restConfiguration()

        Defines the HTTP request and response configuration, validation endpoint, and entity configurations for REST API interactions.

        Returns:
        Defines the HTTP request and response configuration, validation endpoint, and entity configurations for REST API interactions.
      • 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 Map<String,​String> tags()

        The tags you assign to the connection type.

        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 you assign to the connection type.
      • 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