Interface DocumentParameter.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DocumentParameter.Builder,DocumentParameter>, SdkBuilder<DocumentParameter.Builder,DocumentParameter>, SdkPojo
Enclosing class:
DocumentParameter

public static interface DocumentParameter.Builder extends SdkPojo, CopyableBuilder<DocumentParameter.Builder,DocumentParameter>
  • Method Details

    • name

      The name of the parameter.

      Parameters:
      name - The name of the parameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • type

      The type of parameter. The type can be either String or StringList.

      Parameters:
      type - The type of parameter. The type can be either String or StringList.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • type

      The type of parameter. The type can be either String or StringList.

      Parameters:
      type - The type of parameter. The type can be either String or StringList.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • description

      DocumentParameter.Builder description(String description)

      A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

      Parameters:
      description - A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • defaultValue

      DocumentParameter.Builder defaultValue(String defaultValue)

      If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

      Parameters:
      defaultValue - If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
      Returns:
      Returns a reference to this object so that method calls can be chained together.