com.oracle.bmc.oda.model

Class ParameterDefinition.Builder

java.lang.Object

com.oracle.bmc.oda.model.ParameterDefinition.Builder

Enclosing class:

ParameterDefinition

public static class ParameterDefinition.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ParameterDefinition	build()
ParameterDefinition.Builder	copy(ParameterDefinition model)
ParameterDefinition.Builder	defaultValue(String defaultValue) Default value for the parameter.
ParameterDefinition.Builder	description(String description) Description of the parameter.
ParameterDefinition.Builder	direction(ParameterDefinition.Direction direction) Is this parameter an input parameter, output parameter, or both?
ParameterDefinition.Builder	isRequired(Boolean isRequired) Is this parameter required.
ParameterDefinition.Builder	isSensitive(Boolean isSensitive) Is the data for this parameter sensitive (e.g.
ParameterDefinition.Builder	maxLength(Integer maxLength) Used for character string types such as STRING to constrain the length of the value
ParameterDefinition.Builder	minLength(Integer minLength) Used for character string types such as STRING to constrain the length of the value
ParameterDefinition.Builder	name(String name) The name of the parameter
ParameterDefinition.Builder	pattern(String pattern) Regular expression used to validate the value of a string type such as STRING
ParameterDefinition.Builder	resourceTypeMetadata(Object resourceTypeMetadata) Any configuration needed to help the resource type process this parameter (e.g.
ParameterDefinition.Builder	type(ParameterDefinition.Type type) Enumerated parameter type.
ParameterDefinition.Builder	uiPlacementHint(String uiPlacementHint) A forward-slash-delimited ‘path’ in an imaginary hierarchy, at which this parameter’s UI widgets should be placed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

name

public ParameterDefinition.Builder name(String name)

The name of the parameter

Parameters:

name - the value to set

Returns:

this builder

type

public ParameterDefinition.Builder type(ParameterDefinition.Type type)

Enumerated parameter type.

Parameters:

type - the value to set

Returns:

this builder

description

public ParameterDefinition.Builder description(String description)

Description of the parameter.

Parameters:

description - the value to set

Returns:

this builder

isRequired

public ParameterDefinition.Builder isRequired(Boolean isRequired)

Is this parameter required. Ignored for parameters with direction = OUTPUT.

Parameters:

isRequired - the value to set

Returns:

this builder

isSensitive

public ParameterDefinition.Builder isSensitive(Boolean isSensitive)

Is the data for this parameter sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.)

Parameters:

isSensitive - the value to set

Returns:

this builder

defaultValue

public ParameterDefinition.Builder defaultValue(String defaultValue)

Default value for the parameter.

Parameters:

defaultValue - the value to set

Returns:

this builder

minLength

public ParameterDefinition.Builder minLength(Integer minLength)

Used for character string types such as STRING to constrain the length of the value

Parameters:

minLength - the value to set

Returns:

this builder

maxLength

public ParameterDefinition.Builder maxLength(Integer maxLength)

Used for character string types such as STRING to constrain the length of the value

Parameters:

maxLength - the value to set

Returns:

this builder

pattern

public ParameterDefinition.Builder pattern(String pattern)

Regular expression used to validate the value of a string type such as STRING

Parameters:

pattern - the value to set

Returns:

this builder

direction

public ParameterDefinition.Builder direction(ParameterDefinition.Direction direction)

Is this parameter an input parameter, output parameter, or both?

Parameters:

direction - the value to set

Returns:

this builder

uiPlacementHint

public ParameterDefinition.Builder uiPlacementHint(String uiPlacementHint)

A forward-slash-delimited ‘path’ in an imaginary hierarchy, at which this parameter’s UI widgets should be placed

Parameters:

uiPlacementHint - the value to set

Returns:

this builder

resourceTypeMetadata

public ParameterDefinition.Builder resourceTypeMetadata(Object resourceTypeMetadata)

Any configuration needed to help the resource type process this parameter (e.g. link to manifest, etc.).

Parameters:

resourceTypeMetadata - the value to set

Returns:

this builder

build

public ParameterDefinition build()

copy

public ParameterDefinition.Builder copy(ParameterDefinition model)