Class StartEventsDetectionJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartEventsDetectionJobRequest.Builder,
StartEventsDetectionJobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
An unique identifier for the request.final String
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.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 int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the TargetEventTypes property.final InputDataConfig
Specifies the format and location of the input data for the job.final String
jobName()
The identifier of the events detection job.final LanguageCode
The language code of the input documents.final String
The language code of the input documents.final OutputDataConfig
Specifies where to send the output files.static Class
<? extends StartEventsDetectionJobRequest.Builder> tags()
Tags to associate with the events detection job.The types of events to detect in the input documents.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
-
inputDataConfig
Specifies the format and location of the input data for the job.
- Returns:
- Specifies the format and location of the input data for the job.
-
outputDataConfig
Specifies where to send the output files.
- Returns:
- Specifies where to send the output files.
-
dataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
- Returns:
- The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
-
jobName
The identifier of the events detection job.
- Returns:
- The identifier of the events detection job.
-
languageCode
The language code of the input documents.
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code of the input documents.
- See Also:
-
languageCodeAsString
The language code of the input documents.
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language code of the input documents.
- See Also:
-
clientRequestToken
An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
- Returns:
- An unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
-
hasTargetEventTypes
public final boolean hasTargetEventTypes()For responses, this returns true if the service returned a value for the TargetEventTypes 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. -
targetEventTypes
The types of events to detect in the input documents.
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
hasTargetEventTypes()
method.- Returns:
- The types of events to detect in the input documents.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
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
hasTags()
method.- Returns:
- Tags to associate with the events detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.
-
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<StartEventsDetectionJobRequest.Builder,
StartEventsDetectionJobRequest> - Specified by:
toBuilder
in classComprehendRequest
- 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
-