Package com.vmware.aria.operations.definition

Class AdapterDefinition

    • Constructor Detail

      • AdapterDefinition

        AdapterDefinition(String adapterType, String adapterLabel, String adapterInstanceType, String adapterInstanceLabel)

      • AdapterDefinition

        AdapterDefinition(String adapterType, String adapterLabel, String adapterInstanceType)

      • AdapterDefinition

        AdapterDefinition(String adapterType, String adapterLabel)

      • AdapterDefinition

        AdapterDefinition(String adapterType)

    • Method Detail

      • defineStringParameter

        @JvmOverloads() final StringParameter defineStringParameter(String key, String label, String description, String default, Integer maxLength, Boolean required, Boolean advanced)

        Create a new string parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        maxLength - The max length of the parameter value.
        required - True if user is required to provide this parameter.
        advanced - True if the parameter should be collapsed by default.
        Returns:

        The created string parameter definition.

      • defineStringParameter

        @JvmOverloads() final StringParameter defineStringParameter(String key, String label, String description, String default, Integer maxLength, Boolean required)

        Create a new string parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        maxLength - The max length of the parameter value.
        required - True if user is required to provide this parameter.
        Returns:

        The created string parameter definition.

      • defineStringParameter

        @JvmOverloads() final StringParameter defineStringParameter(String key, String label, String description, String default, Integer maxLength)

        Create a new string parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        maxLength - The max length of the parameter value.
        Returns:

        The created string parameter definition.

      • defineStringParameter

        @JvmOverloads() final StringParameter defineStringParameter(String key, String label, String description, String default)

        Create a new string parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        Returns:

        The created string parameter definition.

      • defineStringParameter

        @JvmOverloads() final StringParameter defineStringParameter(String key, String label, String description)

        Create a new string parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        Returns:

        The created string parameter definition.

      • defineStringParameter

        @JvmOverloads() final StringParameter defineStringParameter(String key, String label)

        Create a new string parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        Returns:

        The created string parameter definition.

      • defineStringParameter

        @JvmOverloads() final StringParameter defineStringParameter(String key)

        Create a new string parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        Returns:

        The created string parameter definition.

      • defineStringParameter

         final StringParameter defineStringParameter(String key, Consumer<StringParameterBuilder> block)

        Create a new string parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        block - Anonymous function taking a StringParameterBuilder as a parameter that can be used to override default values.

      • defineIntegerParameter

        @JvmOverloads() final IntParameter defineIntegerParameter(String key, String label, String description, Integer default, Boolean required, Boolean advanced)

        Create a new integer parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        required - True if user is required to provide this parameter.
        advanced - True if the parameter should be collapsed by default.
        Returns:

        The created int parameter definition.

      • defineIntegerParameter

        @JvmOverloads() final IntParameter defineIntegerParameter(String key, String label, String description, Integer default, Boolean required)

        Create a new integer parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        required - True if user is required to provide this parameter.
        Returns:

        The created int parameter definition.

      • defineIntegerParameter

        @JvmOverloads() final IntParameter defineIntegerParameter(String key, String label, String description, Integer default)

        Create a new integer parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        Returns:

        The created int parameter definition.

      • defineIntegerParameter

        @JvmOverloads() final IntParameter defineIntegerParameter(String key, String label, String description)

        Create a new integer parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        Returns:

        The created int parameter definition.

      • defineIntegerParameter

        @JvmOverloads() final IntParameter defineIntegerParameter(String key, String label)

        Create a new integer parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        label - Label that is displayed in the VMware Aria Operations UI.
        Returns:

        The created int parameter definition.

      • defineIntegerParameter

        @JvmOverloads() final IntParameter defineIntegerParameter(String key)

        Create a new integer parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        Returns:

        The created int parameter definition.

      • defineIntegerParameter

         final IntParameter defineIntegerParameter(String key, Consumer<IntegerParameterBuilder> block)

        Create a new integer parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        block - Anonymous function taking an IntegerParameterBuilder as a parameter that can be used to override default values.

      • defineEnumParameter

        @JvmOverloads() final EnumParameter defineEnumParameter(String key, List<EnumParameter.EnumValue> values, String label, String description, String default, Boolean required, Boolean advanced)

        Create a new enum parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        values - A List containing all enum values.
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        required - True if user is required to provide this parameter.
        advanced - True if the parameter should be collapsed by default.
        Returns:

        The created int parameter definition.

      • defineEnumParameter

        @JvmOverloads() final EnumParameter defineEnumParameter(String key, List<EnumParameter.EnumValue> values, String label, String description, String default, Boolean required)

        Create a new enum parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        values - A List containing all enum values.
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        required - True if user is required to provide this parameter.
        Returns:

        The created int parameter definition.

      • defineEnumParameter

        @JvmOverloads() final EnumParameter defineEnumParameter(String key, List<EnumParameter.EnumValue> values, String label, String description, String default)

        Create a new enum parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        values - A List containing all enum values.
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        default - The default value of the parameter.
        Returns:

        The created int parameter definition.

      • defineEnumParameter

        @JvmOverloads() final EnumParameter defineEnumParameter(String key, List<EnumParameter.EnumValue> values, String label, String description)

        Create a new enum parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        values - A List containing all enum values.
        label - Label that is displayed in the VMware Aria Operations UI.
        description - More in-depth explanation of the parameter.
        Returns:

        The created int parameter definition.

      • defineEnumParameter

        @JvmOverloads() final EnumParameter defineEnumParameter(String key, List<EnumParameter.EnumValue> values, String label)

        Create a new enum parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        values - A List containing all enum values.
        label - Label that is displayed in the VMware Aria Operations UI.
        Returns:

        The created int parameter definition.

      • defineEnumParameter

        @JvmOverloads() final EnumParameter defineEnumParameter(String key, List<EnumParameter.EnumValue> values)

        Create a new enum parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        values - A List containing all enum values.
        Returns:

        The created int parameter definition.

      • defineEnumParameter

         final EnumParameter defineEnumParameter(String key, Consumer<EnumParameterBuilder> block)

        Create a new enum parameter and add it to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        key - Used to identify the parameter
        block - Anonymous function taking an EnumParameterBuilder as a parameter that can be used to override default values.

      • addParameter

         final Unit addParameter(Parameter parameter)

        Add a parameter to the adapter instance. The user will be asked to provide a value for this parameter each time a new account/adapter instance is created.

        Parameters:
        parameter - The parameter to add to the adapter instance.

      • defineCredentialType

        @JvmOverloads() final CredentialType defineCredentialType(String key, String label)

        Create a new credential type and add it to this adapter instance. When more than one credential types are present, The user will be required to select the type and then fill in the parameters for that type, as only one credential type can be used for any given adapter instance.

        Parameters:
        key - Used to identify the credential type
        label - Label that is displayed in the VMware Aria Operations UI.
        Returns:

        The created credential type.

      • defineCredentialType

        @JvmOverloads() final CredentialType defineCredentialType(String key)

        Create a new credential type and add it to this adapter instance. When more than one credential types are present, The user will be required to select the type and then fill in the parameters for that type, as only one credential type can be used for any given adapter instance.

        Parameters:
        key - Used to identify the credential type
        Returns:

        The created credential type.

      • defineCredentialType

        @JvmOverloads() final CredentialType defineCredentialType()

        Create a new credential type and add it to this adapter instance. When more than one credential types are present, The user will be required to select the type and then fill in the parameters for that type, as only one credential type can be used for any given adapter instance.

        Returns:

        The created credential type.

      • addCredentialTypes

         final Unit addCredentialTypes(List<CredentialType> credentialTypes)

        Add a list of credential types to the adapter instance.

        Parameters:
        credentialTypes - A list of credential types to add.

      • addCredentialType

         final Unit addCredentialType(CredentialType credentialType)

        Add a credential type to the adapter instance. When more than one credential types are present, The user will be required to select the type and then fill in the parameters for that type, as only one credential type can be used for any given adapter instance.

        Parameters:
        credentialType - The credential type to add.

      • defineObjectType

         final ObjectType defineObjectType(String key, String label)

        Create a new object type definition and add it to this adapter definition.

        Parameters:
        key - The object type
        label - Label that is displayed in the VMware Aria Operations UI for this object type.
        Returns:

        The created object type definition

      • addObjectTypes

         final Unit addObjectTypes(List<ObjectType> objectTypes)

        Adds a list of object types to this adapter definition

        Parameters:
        objectTypes - A list of object type definitions.

      • addObjectType

         final Unit addObjectType(ObjectType objectType)

        Adds an object type to this adapter definition

        Parameters:
        objectType - An object type definition.

      • sendResults

        @JvmOverloads() final Unit sendResults(String outputPipe)

        Opens the output pipe and sends the definition directly back to the server This method can only be called once per collection.

        Parameters:
        outputPipe - The path to the output pipe.

      • sendResults

        @JvmOverloads() final Unit sendResults()

        Opens the output pipe and sends the definition directly back to the server This method can only be called once per collection.