software.amazon.awssdk.services.applicationdiscovery.model

Class StartExportTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.applicationdiscovery.model.ApplicationDiscoveryRequest

software.amazon.awssdk.services.applicationdiscovery.model.StartExportTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartExportTaskRequest.Builder,StartExportTaskRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartExportTaskRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartExportTaskRequest.Builder	builder()
Instant	endTime() The end timestamp for exported data from the single Application Discovery Agent selected in the filters.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<ExportDataFormat>	exportDataFormat() The file format for the returned export data.
List<String>	exportDataFormatAsStrings() The file format for the returned export data.
List<ExportFilter>	filters() If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasExportDataFormat() Returns true if the ExportDataFormat property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasFilters() Returns true if the Filters 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()
List<SdkField<?>>	sdkFields()
static Class<? extends StartExportTaskRequest.Builder>	serializableBuilderClass()
Instant	startTime() The start timestamp for exported data from the single Application Discovery Agent selected in the filters.
StartExportTaskRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

exportDataFormat

public List<ExportDataFormat> exportDataFormat()

The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasExportDataFormat() to see if a value was sent in this field.

Returns:

The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.

hasExportDataFormat

public boolean hasExportDataFormat()

Returns true if the ExportDataFormat 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.

exportDataFormatAsStrings

public List<String> exportDataFormatAsStrings()

The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasExportDataFormat() to see if a value was sent in this field.

Returns:

The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.

hasFilters

public boolean hasFilters()

Returns true if the Filters 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.

filters

public List<ExportFilter> filters()

If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilters() to see if a value was sent in this field.

Returns:

If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.

startTime

public Instant startTime()

The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.

Returns:

The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.

endTime

public Instant endTime()

The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.

Returns:

The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.

toBuilder

public StartExportTaskRequest.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<StartExportTaskRequest.Builder,StartExportTaskRequest>

Specified by:

toBuilder in class ApplicationDiscoveryRequest

Returns:

a builder for type T

builder

public static StartExportTaskRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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 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.