Class ListDatasetEntriesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListDatasetEntriesRequest.Builder,
ListDatasetEntriesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Specifies a label filter for the response.final String
The Amazon Resource Name (ARN) for the dataset that you want to use.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 ContainsLabels property.final Boolean
Specifies an error filter for the response.final int
hashCode()
final Boolean
labeled()
Specifytrue
to get only the JSON Lines where the image is labeled.final Integer
The maximum number of results to return per paginated call.final String
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response.static Class
<? extends ListDatasetEntriesRequest.Builder> final String
If specified,ListDatasetEntries
only returns JSON Lines where the value ofSourceRefContains
is part of thesource-ref
field.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
-
datasetArn
The Amazon Resource Name (ARN) for the dataset that you want to use.
- Returns:
- The Amazon Resource Name (ARN) for the dataset that you want to use.
-
hasContainsLabels
public final boolean hasContainsLabels()For responses, this returns true if the service returned a value for the ContainsLabels 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. -
containsLabels
Specifies a label filter for the response. The response includes an entry only if one or more of the labels in
ContainsLabels
exist in the entry.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
hasContainsLabels()
method.- Returns:
- Specifies a label filter for the response. The response includes an entry only if one or more of the
labels in
ContainsLabels
exist in the entry.
-
labeled
Specify
true
to get only the JSON Lines where the image is labeled. Specifyfalse
to get only the JSON Lines where the image isn't labeled. If you don't specifyLabeled
,ListDatasetEntries
returns JSON Lines for labeled and unlabeled images.- Returns:
- Specify
true
to get only the JSON Lines where the image is labeled. Specifyfalse
to get only the JSON Lines where the image isn't labeled. If you don't specifyLabeled
,ListDatasetEntries
returns JSON Lines for labeled and unlabeled images.
-
sourceRefContains
If specified,
ListDatasetEntries
only returns JSON Lines where the value ofSourceRefContains
is part of thesource-ref
field. Thesource-ref
field contains the Amazon S3 location of the image. You can useSouceRefContains
for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.- Returns:
- If specified,
ListDatasetEntries
only returns JSON Lines where the value ofSourceRefContains
is part of thesource-ref
field. Thesource-ref
field contains the Amazon S3 location of the image. You can useSouceRefContains
for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.
-
hasErrors
Specifies an error filter for the response. Specify
True
to only include entries that have errors.- Returns:
- Specifies an error filter for the response. Specify
True
to only include entries that have errors.
-
nextToken
If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
- Returns:
- If the previous response was incomplete (because there is more results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.
-
maxResults
The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
- Returns:
- The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.
-
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<ListDatasetEntriesRequest.Builder,
ListDatasetEntriesRequest> - Specified by:
toBuilder
in classRekognitionRequest
- 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
-