ConnectionInput (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.glue.model.ConnectionInput

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ConnectionInput.Builder,ConnectionInput>

@Generated(value="software.amazon.awssdk:codegen")
public final class ConnectionInput
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ConnectionInput.Builder,ConnectionInput>

A structure that is used to specify a connection to create or update.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ConnectionInput.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ConnectionInput.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ConnectionInput.Builder`	`builder()`
`Map<ConnectionPropertyKey,String>`	`connectionProperties()` These key-value pairs define parameters for the connection.
`Map<String,String>`	`connectionPropertiesAsStrings()` These key-value pairs define parameters for the connection.
`ConnectionType`	`connectionType()` The type of the connection.
`String`	`connectionTypeAsString()` The type of the connection.
`String`	`description()` The description of the connection.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasConnectionProperties()` Returns true if the ConnectionProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasMatchCriteria()` Returns true if the MatchCriteria property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`matchCriteria()` A list of criteria that can be used in selecting this connection.
`String`	`name()` The name of the connection.
`PhysicalConnectionRequirements`	`physicalConnectionRequirements()` A map of physical connection requirements, such as virtual private cloud (VPC) and `SecurityGroup`, that are needed to successfully make this connection.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ConnectionInput.Builder>`	`serializableBuilderClass()`
`ConnectionInput.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public final String name()
```
    The name of the connection.
    
    Returns:
    
    The name of the connection.
  - description
```
public final String description()
```
    The description of the connection.
    
    Returns:
    
    The description of the connection.
  - connectionType
```
public final ConnectionType connectionType()
```
    The type of the connection. Currently, these types are supported:
    - JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
    - KAFKA - Designates a connection to an Apache Kafka streaming platform.
    - MONGODB - Designates a connection to a MongoDB document database.
    - NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
    - MARKETPLACE - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue.
    - CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue.
    SFTP is not supported.
    
    If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().
    Returns:
    The type of the connection. Currently, these types are supported:
    
    JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
    
    KAFKA - Designates a connection to an Apache Kafka streaming platform.
    
    MONGODB - Designates a connection to a MongoDB document database.
    
    NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
    
    MARKETPLACE - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue.
    
    CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue.
    
    SFTP is not supported.
    See Also:
    
    ConnectionType
  - connectionTypeAsString
```
public final String connectionTypeAsString()
```
    The type of the connection. Currently, these types are supported:
    - JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
    - KAFKA - Designates a connection to an Apache Kafka streaming platform.
    - MONGODB - Designates a connection to a MongoDB document database.
    - NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
    - MARKETPLACE - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue.
    - CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue.
    SFTP is not supported.
    
    If the service returns an enum value that is not available in the current SDK version, connectionType will return ConnectionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectionTypeAsString().
    Returns:
    The type of the connection. Currently, these types are supported:
    
    JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).
    
    KAFKA - Designates a connection to an Apache Kafka streaming platform.
    
    MONGODB - Designates a connection to a MongoDB document database.
    
    NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).
    
    MARKETPLACE - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue.
    
    CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue.
    
    SFTP is not supported.
    See Also:
    
    ConnectionType
  - hasMatchCriteria
```
public final boolean hasMatchCriteria()
```
    Returns true if the MatchCriteria property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - matchCriteria
```
public final List<String> matchCriteria()
```
    A list of criteria that can be used in selecting this connection.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasMatchCriteria() to see if a value was sent in this field.
    
    Returns:
    
    A list of criteria that can be used in selecting this connection.
  - connectionProperties
```
public final Map<ConnectionPropertyKey,String> connectionProperties()
```
    These key-value pairs define parameters for the connection.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasConnectionProperties() to see if a value was sent in this field.
    
    Returns:
    
    These key-value pairs define parameters for the connection.
  - hasConnectionProperties
```
public final boolean hasConnectionProperties()
```
    Returns true if the ConnectionProperties property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - connectionPropertiesAsStrings
```
public final Map<String,String> connectionPropertiesAsStrings()
```
    These key-value pairs define parameters for the connection.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasConnectionProperties() to see if a value was sent in this field.
    
    Returns:
    
    These key-value pairs define parameters for the connection.
  - physicalConnectionRequirements
```
public final PhysicalConnectionRequirements physicalConnectionRequirements()
```
    A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.
    
    Returns:
    
    A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.
  - toBuilder
```
public ConnectionInput.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ConnectionInput.Builder,ConnectionInput>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ConnectionInput.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ConnectionInput.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.15.67

Class ConnectionInput

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

description

connectionType

connectionTypeAsString

hasMatchCriteria

matchCriteria

connectionProperties

hasConnectionProperties

connectionPropertiesAsStrings

physicalConnectionRequirements

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.