Interface Property.Builder

    • Method Detail

      • name

        Property.Builder name​(String name)

        The name of the property.

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

        Property.Builder description​(String description)

        A description of the property.

        Parameters:
        description - A description of the property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • required

        Property.Builder required​(Boolean required)

        Indicates whether the property is required.

        Parameters:
        required - Indicates whether the property is required.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • defaultValue

        Property.Builder defaultValue​(String defaultValue)

        The default value for the property.

        Parameters:
        defaultValue - The default value for the property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • propertyTypesWithStrings

        Property.Builder propertyTypesWithStrings​(Collection<String> propertyTypes)

        Describes the type of property.

        Parameters:
        propertyTypes - Describes the type of property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • propertyTypesWithStrings

        Property.Builder propertyTypesWithStrings​(String... propertyTypes)

        Describes the type of property.

        Parameters:
        propertyTypes - Describes the type of property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • propertyTypes

        Property.Builder propertyTypes​(Collection<PropertyType> propertyTypes)

        Describes the type of property.

        Parameters:
        propertyTypes - Describes the type of property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • propertyTypes

        Property.Builder propertyTypes​(PropertyType... propertyTypes)

        Describes the type of property.

        Parameters:
        propertyTypes - Describes the type of property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • allowedValues

        Property.Builder allowedValues​(Collection<AllowedValue> allowedValues)

        A list of AllowedValue objects representing the values allowed for the property.

        Parameters:
        allowedValues - A list of AllowedValue objects representing the values allowed for the property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • allowedValues

        Property.Builder allowedValues​(AllowedValue... allowedValues)

        A list of AllowedValue objects representing the values allowed for the property.

        Parameters:
        allowedValues - A list of AllowedValue objects representing the values allowed for the property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • allowedValues

        Property.Builder allowedValues​(Consumer<AllowedValue.Builder>... allowedValues)

        A list of AllowedValue objects representing the values allowed for the property.

        This is a convenience method that creates an instance of the AllowedValue.Builder avoiding the need to create one manually via AllowedValue.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #allowedValues(List).

        Parameters:
        allowedValues - a consumer that will call methods on AllowedValue.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #allowedValues(java.util.Collection)
      • dataOperationScopesWithStrings

        Property.Builder dataOperationScopesWithStrings​(Collection<String> dataOperationScopes)

        Indicates which data operations are applicable to the property.

        Parameters:
        dataOperationScopes - Indicates which data operations are applicable to the property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dataOperationScopesWithStrings

        Property.Builder dataOperationScopesWithStrings​(String... dataOperationScopes)

        Indicates which data operations are applicable to the property.

        Parameters:
        dataOperationScopes - Indicates which data operations are applicable to the property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dataOperationScopes

        Property.Builder dataOperationScopes​(Collection<DataOperation> dataOperationScopes)

        Indicates which data operations are applicable to the property.

        Parameters:
        dataOperationScopes - Indicates which data operations are applicable to the property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • dataOperationScopes

        Property.Builder dataOperationScopes​(DataOperation... dataOperationScopes)

        Indicates which data operations are applicable to the property.

        Parameters:
        dataOperationScopes - Indicates which data operations are applicable to the property.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • keyOverride

        Property.Builder keyOverride​(String keyOverride)

        A key name to use when sending this property in API requests, if different from the display name.

        Parameters:
        keyOverride - A key name to use when sending this property in API requests, if different from the display name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • propertyLocation

        Property.Builder propertyLocation​(String propertyLocation)

        Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

        Parameters:
        propertyLocation - Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PropertyLocation, PropertyLocation
      • propertyLocation

        Property.Builder propertyLocation​(PropertyLocation propertyLocation)

        Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

        Parameters:
        propertyLocation - Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PropertyLocation, PropertyLocation