Class CreateFunctionResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateFunctionResponse.Builder,CreateFunctionResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringarn()The ARN of the function.builder()final List<ContextType> The kinds of media context that this function uses.The kinds of media context that this function uses.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 EventBridgeDeliveryModeIndicates whether Elemental Inference also sends this function's results to Amazon EventBridge.final StringIndicates 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 extendsSdkResponse.final booleanFor responses, this returns true if the service returned a value for the ContextTypes property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the References property.final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final Stringid()The ID of the function.final Stringname()The name of the function.The IDs of the feeds that have a function output, enabled or disabled, that references this function.final StringThe JSONata expression that builds the request.final StringThe JSONata expression that selects what to store.static Class<? extends CreateFunctionResponse.Builder> final FunctionStatusstatus()The status of the function.final StringThe status of the function.tags()The tags associated with the 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.services.elementalinference.model.ElementalInferenceResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods 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.
- 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.
-
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.
- 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.
-
description
The description of the function.
- Returns:
- The description of the function.
-
eventBridgeDelivery
Indicates whether Elemental Inference also sends this function's results to Amazon EventBridge. With ENABLED, each result that is a JSON object with a top-level
eventBridgefield set totrueis also sent as a Function Metadata Generated event to the default event bus in your account.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:
- Indicates whether Elemental Inference also sends this function's results to Amazon EventBridge. With
ENABLED, each result that is a JSON object with a top-level
eventBridgefield set totrueis also sent as a Function Metadata Generated event to the default event bus in your account. - See Also:
-
eventBridgeDeliveryAsString
Indicates whether Elemental Inference also sends this function's results to Amazon EventBridge. With ENABLED, each result that is a JSON object with a top-level
eventBridgefield set totrueis also sent as a Function Metadata Generated event to the default event bus in your account.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:
- Indicates whether Elemental Inference also sends this function's results to Amazon EventBridge. With
ENABLED, each result that is a JSON object with a top-level
eventBridgefield set totrueis also sent as a Function Metadata Generated event to the default event bus in your account. - See Also:
-
arn
-
id
-
status
The status of the function. A successful request returns CREATING. The function is ready to use as soon as the request succeeds.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnFunctionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the function. A successful request returns CREATING. The function is ready to use as soon as the request succeeds.
- See Also:
-
statusAsString
The status of the function. A successful request returns CREATING. The function is ready to use as soon as the request succeeds.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnFunctionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the function. A successful request returns CREATING. The function is ready to use as soon as the request succeeds.
- See Also:
-
hasReferences
public final boolean hasReferences()For responses, this returns true if the service returned a value for the References 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. -
references
The IDs of the feeds that have a function output, enabled or disabled, that references this function. While this list isn't empty, the function can't be deleted, and its name and target can't be changed.
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
hasReferences()method.- Returns:
- The IDs of the feeds that have a function output, enabled or disabled, that references this function. While this list isn't empty, the function can't be deleted, and its name and target can't be changed.
-
contextTypes
The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can't set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.
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
hasContextTypes()method.- Returns:
- The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can't set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.
-
hasContextTypes
public final boolean hasContextTypes()For responses, this returns true if the service returned a value for the ContextTypes 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. -
contextTypesAsStrings
The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can't set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.
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
hasContextTypes()method.- Returns:
- The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can't set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.
-
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 associated with the 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 associated with the 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<CreateFunctionResponse.Builder,CreateFunctionResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
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:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. 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, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- 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.
-