@Generated(value="OracleSDKGenerator", comments="API Version: 20190325") public final class CreateConnectionDetails extends Object
Properties used in connection create operations.
Note: Objects should always be created or deserialized using the CreateConnectionDetails.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 CreateConnectionDetails.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
CreateConnectionDetails.Builder |
| Constructor and Description |
|---|
CreateConnectionDetails(String description,
String displayName,
String typeKey,
List<CustomPropertySetUsage> customPropertyMembers,
Map<String,Map<String,String>> properties,
Map<String,Map<String,String>> encProperties,
Boolean isDefault)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateConnectionDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
List<CustomPropertySetUsage> |
getCustomPropertyMembers()
The list of customized properties along with the values for this object
|
String |
getDescription()
A description of the connection.
|
String |
getDisplayName()
A user-friendly display name.
|
Map<String,Map<String,String>> |
getEncProperties()
A map of maps that contains the encrypted values for sensitive properties which are specific to the
connection type.
|
Boolean |
getIsDefault()
Indicates whether this connection is the default connection.
|
Map<String,Map<String,String>> |
getProperties()
A map of maps that contains the properties which are specific to the connection type.
|
String |
getTypeKey()
The key of the object type.
|
int |
hashCode() |
CreateConnectionDetails.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"description","displayName","typeKey","customPropertyMembers","properties","encProperties","isDefault"}) @Deprecated public CreateConnectionDetails(String description, String displayName, String typeKey, List<CustomPropertySetUsage> customPropertyMembers, Map<String,Map<String,String>> properties, Map<String,Map<String,String>> encProperties, Boolean isDefault)
public static CreateConnectionDetails.Builder builder()
Create a new builder.
public CreateConnectionDetails.Builder toBuilder()
public String getDescription()
A description of the connection.
public String getDisplayName()
A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getTypeKey()
The key of the object type. Type key’s can be found via the ‘/types’ endpoint.
public List<CustomPropertySetUsage> getCustomPropertyMembers()
The list of customized properties along with the values for this object
public Map<String,Map<String,String>> getProperties()
A map of maps that contains the properties which are specific to the connection type. Each connection type
definition defines it’s set of required and optional properties. The map keys are category names and the
values are maps of property name to property value. Every property is contained inside of a category. Most
connections have required properties within the "default" category. To determine the set of optional and
required properties for a connection type, a query can be done on ‘/types?type=connection’ that returns a
collection of all connection types. The appropriate connection type, which will include definitions of all
of it’s properties, can be identified from this collection.
Example: {\"properties\": { \"default\": { \"username\": \"user1\"}}}
public Map<String,Map<String,String>> getEncProperties()
A map of maps that contains the encrypted values for sensitive properties which are specific to the
connection type. Each connection type definition defines it’s set of required and optional properties.
The map keys are category names and the values are maps of property name to property value. Every property is
contained inside of a category. Most connections have required properties within the "default" category.
To determine the set of optional and required properties for a connection type, a query can be done
on ‘/types?type=connection’ that returns a collection of all connection types. The appropriate connection
type, which will include definitions of all of it’s properties, can be identified from this collection.
Example: {\"encProperties\": { \"default\": { \"password\": \"pwd\"}}}
public Boolean getIsDefault()
Indicates whether this connection is the default connection. The first connection of a data asset defaults to being the default, subsequent connections default to not being the default. If a default connection already exists, then trying to create a connection as the default will fail. In this case the default connection would need to be updated not to be the default and then the new connection can then be created as the default.
Copyright © 2016–2021. All rights reserved.