software.amazon.awssdk.services.lambda.model.UpdateFunctionUrlConfigRequest Maven / Gradle / Ivy
Show all versions of lambda Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.lambda.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateFunctionUrlConfigRequest extends LambdaRequest implements
ToCopyableBuilder {
private static final SdkField FUNCTION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FunctionName").getter(getter(UpdateFunctionUrlConfigRequest::functionName))
.setter(setter(Builder::functionName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("FunctionName").build()).build();
private static final SdkField QUALIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Qualifier").getter(getter(UpdateFunctionUrlConfigRequest::qualifier)).setter(setter(Builder::qualifier))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("Qualifier").build()).build();
private static final SdkField AUTH_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AuthType").getter(getter(UpdateFunctionUrlConfigRequest::authTypeAsString))
.setter(setter(Builder::authType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AuthType").build()).build();
private static final SdkField CORS_FIELD = SdkField. builder(MarshallingType.SDK_POJO).memberName("Cors")
.getter(getter(UpdateFunctionUrlConfigRequest::cors)).setter(setter(Builder::cors)).constructor(Cors::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Cors").build()).build();
private static final SdkField INVOKE_MODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InvokeMode").getter(getter(UpdateFunctionUrlConfigRequest::invokeModeAsString))
.setter(setter(Builder::invokeMode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InvokeMode").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FUNCTION_NAME_FIELD,
QUALIFIER_FIELD, AUTH_TYPE_FIELD, CORS_FIELD, INVOKE_MODE_FIELD));
private final String functionName;
private final String qualifier;
private final String authType;
private final Cors cors;
private final String invokeMode;
private UpdateFunctionUrlConfigRequest(BuilderImpl builder) {
super(builder);
this.functionName = builder.functionName;
this.qualifier = builder.qualifier;
this.authType = builder.authType;
this.cors = builder.cors;
this.invokeMode = builder.invokeMode;
}
/**
*
* The name or ARN of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
* characters in length.
*
*
* @return The name or ARN of the Lambda function.
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited
* to 64 characters in length.
*/
public final String functionName() {
return functionName;
}
/**
*
* The alias name.
*
*
* @return The alias name.
*/
public final String qualifier() {
return qualifier;
}
/**
*
* The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict
* access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a
* public endpoint. For more information, see Security and auth model for Lambda function
* URLs.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #authType} will
* return {@link FunctionUrlAuthType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #authTypeAsString}.
*
*
* @return The type of authentication that your function URL uses. Set to AWS_IAM if you want to
* restrict access to authenticated users only. Set to NONE if you want to bypass IAM
* authentication to create a public endpoint. For more information, see Security and auth model for Lambda
* function URLs.
* @see FunctionUrlAuthType
*/
public final FunctionUrlAuthType authType() {
return FunctionUrlAuthType.fromValue(authType);
}
/**
*
* The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict
* access to authenticated users only. Set to NONE if you want to bypass IAM authentication to create a
* public endpoint. For more information, see Security and auth model for Lambda function
* URLs.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #authType} will
* return {@link FunctionUrlAuthType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #authTypeAsString}.
*
*
* @return The type of authentication that your function URL uses. Set to AWS_IAM if you want to
* restrict access to authenticated users only. Set to NONE if you want to bypass IAM
* authentication to create a public endpoint. For more information, see Security and auth model for Lambda
* function URLs.
* @see FunctionUrlAuthType
*/
public final String authTypeAsString() {
return authType;
}
/**
*
* The cross-origin resource sharing (CORS)
* settings for your function URL.
*
*
* @return The cross-origin resource sharing
* (CORS) settings for your function URL.
*/
public final Cors cors() {
return cors;
}
/**
*
* Use one of the following options:
*
*
* -
*
* BUFFERED – This is the default option. Lambda invokes your function using the Invoke
* API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
*
*
* -
*
* RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes
* your function using the InvokeWithResponseStream API operation. The maximum response payload size is
* 20 MB, however, you can request a quota
* increase.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #invokeMode} will
* return {@link InvokeMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #invokeModeAsString}.
*
*
* @return Use one of the following options:
*
* -
*
* BUFFERED – This is the default option. Lambda invokes your function using the
* Invoke API operation. Invocation results are available when the payload is complete. The
* maximum payload size is 6 MB.
*
*
* -
*
* RESPONSE_STREAM – Your function streams payload results as they become available. Lambda
* invokes your function using the InvokeWithResponseStream API operation. The maximum response
* payload size is 20 MB, however, you can request a
* quota increase.
*
*
* @see InvokeMode
*/
public final InvokeMode invokeMode() {
return InvokeMode.fromValue(invokeMode);
}
/**
*
* Use one of the following options:
*
*
* -
*
* BUFFERED – This is the default option. Lambda invokes your function using the Invoke
* API operation. Invocation results are available when the payload is complete. The maximum payload size is 6 MB.
*
*
* -
*
* RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes
* your function using the InvokeWithResponseStream API operation. The maximum response payload size is
* 20 MB, however, you can request a quota
* increase.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #invokeMode} will
* return {@link InvokeMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #invokeModeAsString}.
*
*
* @return Use one of the following options:
*
* -
*
* BUFFERED – This is the default option. Lambda invokes your function using the
* Invoke API operation. Invocation results are available when the payload is complete. The
* maximum payload size is 6 MB.
*
*
* -
*
* RESPONSE_STREAM – Your function streams payload results as they become available. Lambda
* invokes your function using the InvokeWithResponseStream API operation. The maximum response
* payload size is 20 MB, however, you can request a
* quota increase.
*
*
* @see InvokeMode
*/
public final String invokeModeAsString() {
return invokeMode;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(functionName());
hashCode = 31 * hashCode + Objects.hashCode(qualifier());
hashCode = 31 * hashCode + Objects.hashCode(authTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(cors());
hashCode = 31 * hashCode + Objects.hashCode(invokeModeAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof UpdateFunctionUrlConfigRequest)) {
return false;
}
UpdateFunctionUrlConfigRequest other = (UpdateFunctionUrlConfigRequest) obj;
return Objects.equals(functionName(), other.functionName()) && Objects.equals(qualifier(), other.qualifier())
&& Objects.equals(authTypeAsString(), other.authTypeAsString()) && Objects.equals(cors(), other.cors())
&& Objects.equals(invokeModeAsString(), other.invokeModeAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("UpdateFunctionUrlConfigRequest").add("FunctionName", functionName())
.add("Qualifier", qualifier()).add("AuthType", authTypeAsString()).add("Cors", cors())
.add("InvokeMode", invokeModeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "FunctionName":
return Optional.ofNullable(clazz.cast(functionName()));
case "Qualifier":
return Optional.ofNullable(clazz.cast(qualifier()));
case "AuthType":
return Optional.ofNullable(clazz.cast(authTypeAsString()));
case "Cors":
return Optional.ofNullable(clazz.cast(cors()));
case "InvokeMode":
return Optional.ofNullable(clazz.cast(invokeModeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateFunctionUrlConfigRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends LambdaRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name or ARN of the Lambda function.
*
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is limited to
* 64 characters in length.
*
*
* @param functionName
* The name or ARN of the Lambda function.
*
* Name formats
*
*
* -
*
* Function name – my-function.
*
*
* -
*
* Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.
*
*
* -
*
* Partial ARN – 123456789012:function:my-function.
*
*
*
*
* The length constraint applies only to the full ARN. If you specify only the function name, it is
* limited to 64 characters in length.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder functionName(String functionName);
/**
*
* The alias name.
*
*
* @param qualifier
* The alias name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder qualifier(String qualifier);
/**
*
* The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict
* access to authenticated users only. Set to NONE if you want to bypass IAM authentication to
* create a public endpoint. For more information, see Security and auth model for Lambda
* function URLs.
*
*
* @param authType
* The type of authentication that your function URL uses. Set to AWS_IAM if you want to
* restrict access to authenticated users only. Set to NONE if you want to bypass IAM
* authentication to create a public endpoint. For more information, see Security and auth model for Lambda
* function URLs.
* @see FunctionUrlAuthType
* @return Returns a reference to this object so that method calls can be chained together.
* @see FunctionUrlAuthType
*/
Builder authType(String authType);
/**
*
* The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict
* access to authenticated users only. Set to NONE if you want to bypass IAM authentication to
* create a public endpoint. For more information, see Security and auth model for Lambda
* function URLs.
*
*
* @param authType
* The type of authentication that your function URL uses. Set to AWS_IAM if you want to
* restrict access to authenticated users only. Set to NONE if you want to bypass IAM
* authentication to create a public endpoint. For more information, see Security and auth model for Lambda
* function URLs.
* @see FunctionUrlAuthType
* @return Returns a reference to this object so that method calls can be chained together.
* @see FunctionUrlAuthType
*/
Builder authType(FunctionUrlAuthType authType);
/**
*
* The cross-origin resource sharing (CORS)
* settings for your function URL.
*
*
* @param cors
* The cross-origin resource sharing
* (CORS) settings for your function URL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cors(Cors cors);
/**
*
* The cross-origin resource sharing (CORS)
* settings for your function URL.
*
* This is a convenience method that creates an instance of the {@link Cors.Builder} avoiding the need to create
* one manually via {@link Cors#builder()}.
*
*
* When the {@link Consumer} completes, {@link Cors.Builder#build()} is called immediately and its result is
* passed to {@link #cors(Cors)}.
*
* @param cors
* a consumer that will call methods on {@link Cors.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #cors(Cors)
*/
default Builder cors(Consumer cors) {
return cors(Cors.builder().applyMutation(cors).build());
}
/**
*
* Use one of the following options:
*
*
* -
*
* BUFFERED – This is the default option. Lambda invokes your function using the
* Invoke API operation. Invocation results are available when the payload is complete. The maximum
* payload size is 6 MB.
*
*
* -
*
* RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes
* your function using the InvokeWithResponseStream API operation. The maximum response payload
* size is 20 MB, however, you can request a quota
* increase.
*
*
*
*
* @param invokeMode
* Use one of the following options:
*
* -
*
* BUFFERED – This is the default option. Lambda invokes your function using the
* Invoke API operation. Invocation results are available when the payload is complete. The
* maximum payload size is 6 MB.
*
*
* -
*
* RESPONSE_STREAM – Your function streams payload results as they become available. Lambda
* invokes your function using the InvokeWithResponseStream API operation. The maximum
* response payload size is 20 MB, however, you can request
* a quota increase.
*
*
* @see InvokeMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see InvokeMode
*/
Builder invokeMode(String invokeMode);
/**
*
* Use one of the following options:
*
*
* -
*
* BUFFERED – This is the default option. Lambda invokes your function using the
* Invoke API operation. Invocation results are available when the payload is complete. The maximum
* payload size is 6 MB.
*
*
* -
*
* RESPONSE_STREAM – Your function streams payload results as they become available. Lambda invokes
* your function using the InvokeWithResponseStream API operation. The maximum response payload
* size is 20 MB, however, you can request a quota
* increase.
*
*
*
*
* @param invokeMode
* Use one of the following options:
*
* -
*
* BUFFERED – This is the default option. Lambda invokes your function using the
* Invoke API operation. Invocation results are available when the payload is complete. The
* maximum payload size is 6 MB.
*
*
* -
*
* RESPONSE_STREAM – Your function streams payload results as they become available. Lambda
* invokes your function using the InvokeWithResponseStream API operation. The maximum
* response payload size is 20 MB, however, you can request
* a quota increase.
*
*
* @see InvokeMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see InvokeMode
*/
Builder invokeMode(InvokeMode invokeMode);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends LambdaRequest.BuilderImpl implements Builder {
private String functionName;
private String qualifier;
private String authType;
private Cors cors;
private String invokeMode;
private BuilderImpl() {
}
private BuilderImpl(UpdateFunctionUrlConfigRequest model) {
super(model);
functionName(model.functionName);
qualifier(model.qualifier);
authType(model.authType);
cors(model.cors);
invokeMode(model.invokeMode);
}
public final String getFunctionName() {
return functionName;
}
public final void setFunctionName(String functionName) {
this.functionName = functionName;
}
@Override
public final Builder functionName(String functionName) {
this.functionName = functionName;
return this;
}
public final String getQualifier() {
return qualifier;
}
public final void setQualifier(String qualifier) {
this.qualifier = qualifier;
}
@Override
public final Builder qualifier(String qualifier) {
this.qualifier = qualifier;
return this;
}
public final String getAuthType() {
return authType;
}
public final void setAuthType(String authType) {
this.authType = authType;
}
@Override
public final Builder authType(String authType) {
this.authType = authType;
return this;
}
@Override
public final Builder authType(FunctionUrlAuthType authType) {
this.authType(authType == null ? null : authType.toString());
return this;
}
public final Cors.Builder getCors() {
return cors != null ? cors.toBuilder() : null;
}
public final void setCors(Cors.BuilderImpl cors) {
this.cors = cors != null ? cors.build() : null;
}
@Override
public final Builder cors(Cors cors) {
this.cors = cors;
return this;
}
public final String getInvokeMode() {
return invokeMode;
}
public final void setInvokeMode(String invokeMode) {
this.invokeMode = invokeMode;
}
@Override
public final Builder invokeMode(String invokeMode) {
this.invokeMode = invokeMode;
return this;
}
@Override
public final Builder invokeMode(InvokeMode invokeMode) {
this.invokeMode(invokeMode == null ? null : invokeMode.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public UpdateFunctionUrlConfigRequest build() {
return new UpdateFunctionUrlConfigRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}