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("software.amazon.awssdk:codegen") public final class StartExportTaskRequest extends ApplicationDiscoveryRequest implements ToCopyableBuilder<StartExportTaskRequest.Builder,StartExportTaskRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStartExportTaskRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StartExportTaskRequest.Builderbuilder()InstantendTime()The end timestamp for exported data from the single Application Discovery Agent selected in the filters.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)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 singleagentIdof the Application Discovery Agent for which data is exported.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasExportDataFormat()For responses, this returns true if the service returned a value for the ExportDataFormat property.booleanhasFilters()For responses, this returns true if the service returned a value for the Filters property.inthashCode()ExportPreferencespreferences()Indicates the type of data that needs to be exported.List<SdkField<?>>sdkFields()static Class<? extends StartExportTaskRequest.Builder>serializableBuilderClass()InstantstartTime()The start timestamp for exported data from the single Application Discovery Agent selected in the filters.StartExportTaskRequest.BuildertoBuilder()StringtoString()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
-
exportDataFormat
public final List<ExportDataFormat> exportDataFormat()
The file format for the returned export data. Default value is
CSV. Note: TheGRAPHMLoption has been deprecated.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
hasExportDataFormat()method.- Returns:
- The file format for the returned export data. Default value is
CSV. Note: TheGRAPHMLoption has been deprecated.
-
hasExportDataFormat
public final boolean hasExportDataFormat()
For responses, this returns true if the service returned a value for the ExportDataFormat property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
exportDataFormatAsStrings
public final List<String> exportDataFormatAsStrings()
The file format for the returned export data. Default value is
CSV. Note: TheGRAPHMLoption has been deprecated.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
hasExportDataFormat()method.- Returns:
- The file format for the returned export data. Default value is
CSV. Note: TheGRAPHMLoption has been deprecated.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
filters
public final List<ExportFilter> filters()
If a filter is present, it selects the single
agentIdof the Application Discovery Agent for which data is exported. TheagentIdcan be found in the results of theDescribeAgentsAPI or CLI. If no filter is present,startTimeandendTimeare ignored and exported data includes both Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery Agent agents.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
hasFilters()method.- Returns:
- If a filter is present, it selects the single
agentIdof the Application Discovery Agent for which data is exported. TheagentIdcan be found in the results of theDescribeAgentsAPI or CLI. If no filter is present,startTimeandendTimeare ignored and exported data includes both Amazon Web Services Application Discovery Service Agentless Collector collectors data and summary data from Application Discovery Agent agents.
-
startTime
public final 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 final 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.
-
preferences
public final ExportPreferences preferences()
Indicates the type of data that needs to be exported. Only one ExportPreferences can be enabled at any time.
- Returns:
- Indicates the type of data that needs to be exported. Only one ExportPreferences can be enabled at any time.
-
toBuilder
public StartExportTaskRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StartExportTaskRequest.Builder,StartExportTaskRequest>- Specified by:
toBuilderin classApplicationDiscoveryRequest
-
builder
public static StartExportTaskRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartExportTaskRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-