Class GetConnectionResponse

    • Method Detail

      • connectionCredentials

        public final ConnectionCredentials connectionCredentials()

        Connection credentials.

        Returns:
        Connection credentials.
      • connectionId

        public final String connectionId()

        The ID of the connection.

        Returns:
        The ID of the connection.
      • description

        public final String description()

        Connection description.

        Returns:
        Connection description.
      • domainId

        public final String domainId()

        The domain ID of the connection.

        Returns:
        The domain ID of the connection.
      • domainUnitId

        public final String domainUnitId()

        The domain unit ID of the connection.

        Returns:
        The domain unit ID of the connection.
      • environmentId

        public final String environmentId()

        The ID of the environment.

        Returns:
        The ID of the environment.
      • environmentUserRole

        public final String environmentUserRole()

        The environment user role.

        Returns:
        The environment user role.
      • name

        public final String name()

        The name of the connection.

        Returns:
        The name of the connection.
      • hasPhysicalEndpoints

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

        public final List<PhysicalEndpoint> physicalEndpoints()

        The physical endpoints of the connection.

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

        Returns:
        The physical endpoints of the connection.
      • projectId

        public final String projectId()

        The ID of the project.

        Returns:
        The ID of the project.
      • typeAsString

        public final String typeAsString()

        The type of the connection.

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

        Returns:
        The type of the connection.
        See Also:
        ConnectionType
      • 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