DescribedConnector (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.transfer.model.DescribedConnector

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DescribedConnector.Builder,DescribedConnector>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class DescribedConnector
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DescribedConnector.Builder,DescribedConnector>
```
Describes the parameters for the connector, as identified by the ConnectorId.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribedConnector.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`accessRole()` With AS2, you can send files by calling `StartFileTransfer` and specifying the file paths in the request parameter, `SendFilePaths`.
`String`	`arn()` The unique Amazon Resource Name (ARN) for the connector.
`As2ConnectorConfig`	`as2Config()` A structure that contains the parameters for a connector object.
`static DescribedConnector.Builder`	`builder()`
`String`	`connectorId()` The unique identifier for the connector.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`loggingRole()` The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribedConnector.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` Key-value pairs that can be used to group and search for connectors.
`DescribedConnector.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`url()` The URL of the partner's AS2 endpoint.

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

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

- Method Detail
  - arn
```
public final String arn()
```
    The unique Amazon Resource Name (ARN) for the connector.
    
    Returns:
    
    The unique Amazon Resource Name (ARN) for the connector.
  - connectorId
```
public final String connectorId()
```
    The unique identifier for the connector.
    
    Returns:
    
    The unique identifier for the connector.
  - url
```
public final String url()
```
    The URL of the partner's AS2 endpoint.
    
    Returns:
    
    The URL of the partner's AS2 endpoint.
  - as2Config
```
public final As2ConnectorConfig as2Config()
```
    A structure that contains the parameters for a connector object.
    
    Returns:
    
    A structure that contains the parameters for a connector object.
  - accessRole
```
public final String accessRole()
```
    With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.
    
    Returns:
    
    With AS2, you can send files by calling StartFileTransfer and specifying the file paths in the request parameter, SendFilePaths. We use the file’s parent directory (for example, for --send-file-paths /bucket/dir/file.txt, parent directory is /bucket/dir/) to temporarily store a processed AS2 message file, store the MDN when we receive them from the partner, and write a final JSON file containing relevant metadata of the transmission. So, the AccessRole needs to provide read and write access to the parent directory of the file location used in the StartFileTransfer request. Additionally, you need to provide read and write access to the parent directory of the files that you intend to send with StartFileTransfer.
  - loggingRole
```
public final String loggingRole()
```
    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a connector to turn on CloudWatch logging for Amazon S3 events. When set, you can view connector activity in your CloudWatch logs.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    Key-value pairs that can be used to group and search for connectors.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    Key-value pairs that can be used to group and search for connectors.
  - toBuilder
```
public DescribedConnector.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribedConnector.Builder,DescribedConnector>
  - builder
```
public static DescribedConnector.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribedConnector.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class DescribedConnector

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

connectorId

url

as2Config

accessRole

loggingRole

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields