com.oracle.bmc.oda.model

Class ParameterDefinition

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.oda.model.ParameterDefinition

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190506")
public final class ParameterDefinition
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A parameter to a resource.
Note: Objects should always be created or deserialized using the ParameterDefinition.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ParameterDefinition.Builder, which maintain a set of all explicitly set fields called ParameterDefinition.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterDefinition.Builder
static class	ParameterDefinition.Direction Is this parameter an input parameter, output parameter, or both?
static class	ParameterDefinition.Type Enumerated parameter type.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
ParameterDefinition(String name, ParameterDefinition.Type type, String description, Boolean isRequired, Boolean isSensitive, String defaultValue, Integer minLength, Integer maxLength, String pattern, ParameterDefinition.Direction direction, String uiPlacementHint, Object resourceTypeMetadata) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ParameterDefinition.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getDefaultValue() Default value for the parameter.
String	getDescription() Description of the parameter.
ParameterDefinition.Direction	getDirection() Is this parameter an input parameter, output parameter, or both?
Boolean	getIsRequired() Is this parameter required.
Boolean	getIsSensitive() Is the data for this parameter sensitive (e.g.
Integer	getMaxLength() Used for character string types such as STRING to constrain the length of the value
Integer	getMinLength() Used for character string types such as STRING to constrain the length of the value
String	getName() The name of the parameter
String	getPattern() Regular expression used to validate the value of a string type such as STRING
Object	getResourceTypeMetadata() Any configuration needed to help the resource type process this parameter (e.g.
ParameterDefinition.Type	getType() Enumerated parameter type.
String	getUiPlacementHint() A forward-slash-delimited ‘path’ in an imaginary hierarchy, at which this parameter’s UI widgets should be placed
int	hashCode()
ParameterDefinition.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterDefinition

@Deprecated
 @ConstructorProperties(value={"name","type","description","isRequired","isSensitive","defaultValue","minLength","maxLength","pattern","direction","uiPlacementHint","resourceTypeMetadata"})
public ParameterDefinition(String name,
                                                                                                                                                                                                                                     ParameterDefinition.Type type,
                                                                                                                                                                                                                                     String description,
                                                                                                                                                                                                                                     Boolean isRequired,
                                                                                                                                                                                                                                     Boolean isSensitive,
                                                                                                                                                                                                                                     String defaultValue,
                                                                                                                                                                                                                                     Integer minLength,
                                                                                                                                                                                                                                     Integer maxLength,
                                                                                                                                                                                                                                     String pattern,
                                                                                                                                                                                                                                     ParameterDefinition.Direction direction,
                                                                                                                                                                                                                                     String uiPlacementHint,
                                                                                                                                                                                                                                     Object resourceTypeMetadata)

Deprecated.

Method Detail

builder

public static ParameterDefinition.Builder builder()

Create a new builder.

toBuilder

public ParameterDefinition.Builder toBuilder()

getName

public String getName()

The name of the parameter

Returns:

the value

getType

public ParameterDefinition.Type getType()

Enumerated parameter type.

Returns:

the value

getDescription

public String getDescription()

Description of the parameter.

Returns:

the value

getIsRequired

public Boolean getIsRequired()

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

Returns:

the value

getIsSensitive

public Boolean getIsSensitive()

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

Returns:

the value

getDefaultValue

public String getDefaultValue()

Default value for the parameter.

Returns:

the value

getMinLength

public Integer getMinLength()

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

Returns:

the value

getMaxLength

public Integer getMaxLength()

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

Returns:

the value

getPattern

public String getPattern()

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

Returns:

the value

getDirection

public ParameterDefinition.Direction getDirection()

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

Returns:

the value

getUiPlacementHint

public String getUiPlacementHint()

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

Returns:

the value

getResourceTypeMetadata

public Object getResourceTypeMetadata()

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

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel