Class CreateFunctionRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringThe description of the function.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EventBridgeDeliveryModeSpecifies whether Elemental Inference also sends this function's results to Amazon EventBridge.final StringSpecifies whether Elemental Inference also sends this function's results to Amazon EventBridge.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final Stringname()A name for this function.final StringThe JSONata expression that builds the request.final StringThe JSONata expression that selects what to store.static Class<? extends CreateFunctionRequest.Builder> tags()The tags to associate with this function.final FunctionTargettarget()The destination for the request that the function builds.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
-
target
The destination for the request that the function builds.
- Returns:
- The destination for the request that the function builds.
-
requestExpression
The JSONata expression that builds the request. Elemental Inference evaluates it against the media object of the feed, which holds the media and metadata that the function asked for. Maximum length: 5,120 characters.
When you save the function, Elemental Inference evaluates the expression against sample media and rejects it if the evaluation fails. For a Bedrock target, the result must be a JSON object; Elemental Inference doesn't check that the object is a valid request body for the model. The expression can reference at most one of media.transcript, media.contextual, and media.clip. For a passthrough target, it can't reference media.frames.
- Returns:
- The JSONata expression that builds the request. Elemental Inference evaluates it against the media object
of the feed, which holds the media and metadata that the function asked for. Maximum length: 5,120
characters.
When you save the function, Elemental Inference evaluates the expression against sample media and rejects it if the evaluation fails. For a Bedrock target, the result must be a JSON object; Elemental Inference doesn't check that the object is a valid request body for the model. The expression can reference at most one of media.transcript, media.contextual, and media.clip. For a passthrough target, it can't reference media.frames.
-
responseExpression
The JSONata expression that selects what to store. Elemental Inference evaluates it against the result as its root: the model response for a Bedrock target, or the output of the request expression for a passthrough target. If a function has no response expression, Elemental Inference stores the entire result. Maximum length: 5,120 characters.
When you save the function, Elemental Inference checks that the expression is valid JSONata. For a passthrough target, it also evaluates the request and response expressions together against sample media, and rejects them if they produce no value.
- Returns:
- The JSONata expression that selects what to store. Elemental Inference evaluates it against the result as
its root: the model response for a Bedrock target, or the output of the request expression for a
passthrough target. If a function has no response expression, Elemental Inference stores the entire
result. Maximum length: 5,120 characters.
When you save the function, Elemental Inference checks that the expression is valid JSONata. For a passthrough target, it also evaluates the request and response expressions together against sample media, and rejects them if they produce no value.
-
description
The description of the function. Maximum length: 1,024 characters.
- Returns:
- The description of the function. Maximum length: 1,024 characters.
-
eventBridgeDelivery
Specifies whether Elemental Inference also sends this function's results to Amazon EventBridge. Elemental Inference sends a result only when the result is a JSON object with a top-level
eventBridgefield set totrue. It sends the result, unchanged, as a Function Metadata Generated event to the default event bus in your account, after the result is available from GetMetadata. If the result is larger than 64 KB, the event hasresultOmittedset totruein place of the result.Valid values:
-
ENABLED – Elemental Inference sends each marked result as an event.
-
DISABLED (default) – Elemental Inference doesn't send events.
For a Bedrock target, ENABLED requires a response expression, because the model response itself never has a top-level
eventBridgefield. A feed output that runs a function with ENABLED can't use a fixedInterval trigger shorter than 4 seconds.If the service returns an enum value that is not available in the current SDK version,
eventBridgeDeliverywill returnEventBridgeDeliveryMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventBridgeDeliveryAsString().- Returns:
- Specifies whether Elemental Inference also sends this function's results to Amazon EventBridge. Elemental
Inference sends a result only when the result is a JSON object with a top-level
eventBridgefield set totrue. It sends the result, unchanged, as a Function Metadata Generated event to the default event bus in your account, after the result is available from GetMetadata. If the result is larger than 64 KB, the event hasresultOmittedset totruein place of the result.Valid values:
-
ENABLED – Elemental Inference sends each marked result as an event.
-
DISABLED (default) – Elemental Inference doesn't send events.
For a Bedrock target, ENABLED requires a response expression, because the model response itself never has a top-level
eventBridgefield. A feed output that runs a function with ENABLED can't use a fixedInterval trigger shorter than 4 seconds. -
- See Also:
-
-
eventBridgeDeliveryAsString
Specifies whether Elemental Inference also sends this function's results to Amazon EventBridge. Elemental Inference sends a result only when the result is a JSON object with a top-level
eventBridgefield set totrue. It sends the result, unchanged, as a Function Metadata Generated event to the default event bus in your account, after the result is available from GetMetadata. If the result is larger than 64 KB, the event hasresultOmittedset totruein place of the result.Valid values:
-
ENABLED – Elemental Inference sends each marked result as an event.
-
DISABLED (default) – Elemental Inference doesn't send events.
For a Bedrock target, ENABLED requires a response expression, because the model response itself never has a top-level
eventBridgefield. A feed output that runs a function with ENABLED can't use a fixedInterval trigger shorter than 4 seconds.If the service returns an enum value that is not available in the current SDK version,
eventBridgeDeliverywill returnEventBridgeDeliveryMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromeventBridgeDeliveryAsString().- Returns:
- Specifies whether Elemental Inference also sends this function's results to Amazon EventBridge. Elemental
Inference sends a result only when the result is a JSON object with a top-level
eventBridgefield set totrue. It sends the result, unchanged, as a Function Metadata Generated event to the default event bus in your account, after the result is available from GetMetadata. If the result is larger than 64 KB, the event hasresultOmittedset totruein place of the result.Valid values:
-
ENABLED – Elemental Inference sends each marked result as an event.
-
DISABLED (default) – Elemental Inference doesn't send events.
For a Bedrock target, ENABLED requires a response expression, because the model response itself never has a top-level
eventBridgefield. A feed output that runs a function with ENABLED can't use a fixedInterval trigger shorter than 4 seconds. -
- See Also:
-
-
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
The tags to associate with this function.
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:
- The tags to associate with this function.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateFunctionRequest.Builder,CreateFunctionRequest> - Specified by:
toBuilderin classElementalInferenceRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
Description copied from class:SdkRequestUsed 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:
getValueForFieldin 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-