Class StartExportTaskRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartExportTaskRequest.Builder,
StartExportTaskRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
endTime()
The end timestamp for exported data from the single Application Discovery Agent selected in the filters.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<ExportDataFormat> The file format for the returned export data.The file format for the returned export data.final List
<ExportFilter> filters()
If a filter is present, it selects the singleagentId
of the Application Discovery Agent for which data is exported.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the ExportDataFormat property.final boolean
For responses, this returns true if the service returned a value for the Filters property.final int
hashCode()
final ExportPreferences
Indicates the type of data that needs to be exported.static Class
<? extends StartExportTaskRequest.Builder> final Instant
The start timestamp for exported data from the single Application Discovery Agent selected in the filters.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
exportDataFormat
The file format for the returned export data. Default value is
CSV
. Note: TheGRAPHML
option 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: TheGRAPHML
option 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
The file format for the returned export data. Default value is
CSV
. Note: TheGRAPHML
option 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: TheGRAPHML
option 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
If a filter is present, it selects the single
agentId
of the Application Discovery Agent for which data is exported. TheagentId
can be found in the results of theDescribeAgents
API or CLI. If no filter is present,startTime
andendTime
are 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
agentId
of the Application Discovery Agent for which data is exported. TheagentId
can be found in the results of theDescribeAgents
API or CLI. If no filter is present,startTime
andendTime
are 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
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
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
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
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 interfaceToCopyableBuilder<StartExportTaskRequest.Builder,
StartExportTaskRequest> - Specified by:
toBuilder
in classApplicationDiscoveryRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-