software.amazon.awssdk.services.appflow.model

Class ResetConnectorMetadataCacheRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appflow.model.AppflowRequest

software.amazon.awssdk.services.appflow.model.ResetConnectorMetadataCacheRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ResetConnectorMetadataCacheRequest.Builder,ResetConnectorMetadataCacheRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ResetConnectorMetadataCacheRequest
extends AppflowRequest
implements ToCopyableBuilder<ResetConnectorMetadataCacheRequest.Builder,ResetConnectorMetadataCacheRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResetConnectorMetadataCacheRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	apiVersion() The API version that you specified in the connector profile that you’re resetting cached metadata for.
static ResetConnectorMetadataCacheRequest.Builder	builder()
String	connectorEntityName() Use this parameter if you want to reset cached metadata about the details for an individual entity.
String	connectorProfileName() The name of the connector profile that you want to reset cached metadata for.
ConnectorType	connectorType() The type of connector to reset cached metadata for.
String	connectorTypeAsString() The type of connector to reset cached metadata for.
String	entitiesPath() Use this parameter only if you’re resetting the cached metadata about a nested entity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ResetConnectorMetadataCacheRequest.Builder>	serializableBuilderClass()
ResetConnectorMetadataCacheRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

connectorProfileName

public final String connectorProfileName()

The name of the connector profile that you want to reset cached metadata for.

You can omit this parameter if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this parameter in your request.

Returns:

The name of the connector profile that you want to reset cached metadata for.

You can omit this parameter if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this parameter in your request.

connectorType

public final ConnectorType connectorType()

The type of connector to reset cached metadata for.

You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.

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

Returns:

The type of connector to reset cached metadata for.

You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.

See Also:

ConnectorType

connectorTypeAsString

public final String connectorTypeAsString()

The type of connector to reset cached metadata for.

You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.

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

Returns:

The type of connector to reset cached metadata for.

You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.

See Also:

ConnectorType

connectorEntityName

public final String connectorEntityName()

Use this parameter if you want to reset cached metadata about the details for an individual entity.

If you don't include this parameter in your request, Amazon AppFlow only resets cached metadata about entity names, not entity details.

Returns:

Use this parameter if you want to reset cached metadata about the details for an individual entity.

If you don't include this parameter in your request, Amazon AppFlow only resets cached metadata about entity names, not entity details.

entitiesPath

public final String entitiesPath()

Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors support nested entities. A nested entity is one that has another entity as a parent. To use this parameter, specify the name of the parent entity.

To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that parent.

Returns:

Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors support nested entities. A nested entity is one that has another entity as a parent. To use this parameter, specify the name of the parent entity.

To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that parent.

apiVersion

public final String apiVersion()

The API version that you specified in the connector profile that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector.

To look up how many versions a connector supports, use the DescribeConnectors action. In the response, find the value that Amazon AppFlow returns for the connectorVersion parameter.

To look up the connector type, use the DescribeConnectorProfiles action. In the response, find the value that Amazon AppFlow returns for the connectorType parameter.

To look up the API version that you specified in a connector profile, use the DescribeConnectorProfiles action.

Returns:

The API version that you specified in the connector profile that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector.

To look up how many versions a connector supports, use the DescribeConnectors action. In the response, find the value that Amazon AppFlow returns for the connectorVersion parameter.

To look up the connector type, use the DescribeConnectorProfiles action. In the response, find the value that Amazon AppFlow returns for the connectorType parameter.

To look up the API version that you specified in a connector profile, use the DescribeConnectorProfiles action.

toBuilder

public ResetConnectorMetadataCacheRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResetConnectorMetadataCacheRequest.Builder,ResetConnectorMetadataCacheRequest>

Specified by:

toBuilder in class AppflowRequest

builder

public static ResetConnectorMetadataCacheRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ResetConnectorMetadataCacheRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo