Class DescribeConnectorOperationResponse

  • Method Details

    • connectorArn

      public final String connectorArn()

      The Amazon Resource Name (ARN) of the connector.

      Returns:
      The Amazon Resource Name (ARN) of the connector.
    • connectorOperationArn

      public final String connectorOperationArn()

      The Amazon Resource Name (ARN) of the connector operation.

      Returns:
      The Amazon Resource Name (ARN) of the connector operation.
    • connectorOperationState

      public final ConnectorOperationState connectorOperationState()

      The state of the connector operation.

      If the service returns an enum value that is not available in the current SDK version, connectorOperationState will return ConnectorOperationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectorOperationStateAsString().

      Returns:
      The state of the connector operation.
      See Also:
    • connectorOperationStateAsString

      public final String connectorOperationStateAsString()

      The state of the connector operation.

      If the service returns an enum value that is not available in the current SDK version, connectorOperationState will return ConnectorOperationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectorOperationStateAsString().

      Returns:
      The state of the connector operation.
      See Also:
    • connectorOperationType

      public final ConnectorOperationType connectorOperationType()

      The type of connector operation performed.

      If the service returns an enum value that is not available in the current SDK version, connectorOperationType will return ConnectorOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectorOperationTypeAsString().

      Returns:
      The type of connector operation performed.
      See Also:
    • connectorOperationTypeAsString

      public final String connectorOperationTypeAsString()

      The type of connector operation performed.

      If the service returns an enum value that is not available in the current SDK version, connectorOperationType will return ConnectorOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from connectorOperationTypeAsString().

      Returns:
      The type of connector operation performed.
      See Also:
    • hasOperationSteps

      public final boolean hasOperationSteps()
      For responses, this returns true if the service returned a value for the OperationSteps 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.
    • operationSteps

      public final List<ConnectorOperationStep> operationSteps()

      The array of operation steps taken.

      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 hasOperationSteps() method.

      Returns:
      The array of operation steps taken.
    • originWorkerSetting

      public final WorkerSetting originWorkerSetting()

      The origin worker setting.

      Returns:
      The origin worker setting.
    • hasOriginConnectorConfiguration

      public final boolean hasOriginConnectorConfiguration()
      For responses, this returns true if the service returned a value for the OriginConnectorConfiguration 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.
    • originConnectorConfiguration

      public final Map<String,String> originConnectorConfiguration()

      The origin connector configuration.

      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 hasOriginConnectorConfiguration() method.

      Returns:
      The origin connector configuration.
    • targetWorkerSetting

      public final WorkerSetting targetWorkerSetting()

      The target worker setting.

      Returns:
      The target worker setting.
    • hasTargetConnectorConfiguration

      public final boolean hasTargetConnectorConfiguration()
      For responses, this returns true if the service returned a value for the TargetConnectorConfiguration 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.
    • targetConnectorConfiguration

      public final Map<String,String> targetConnectorConfiguration()

      The target connector configuration.

      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 hasTargetConnectorConfiguration() method.

      Returns:
      The target connector configuration.
    • errorInfo

      public final StateDescription errorInfo()
      Returns the value of the ErrorInfo property for this object.
      Returns:
      The value of the ErrorInfo property for this object.
    • creationTime

      public final Instant creationTime()

      The time when the operation was created.

      Returns:
      The time when the operation was created.
    • endTime

      public final Instant endTime()

      The time when the operation ended.

      Returns:
      The time when the operation ended.
    • 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<DescribeConnectorOperationResponse.Builder,DescribeConnectorOperationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends DescribeConnectorOperationResponse.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse
    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.