software.amazon.awssdk.services.eventbridge.model.CreateConnectionOAuthRequestParameters Maven / Gradle / Ivy
Show all versions of eventbridge 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.eventbridge.model;
import java.io.Serializable;
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.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;
/**
*
* Contains the OAuth authorization parameters to use for the connection.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateConnectionOAuthRequestParameters implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField CLIENT_PARAMETERS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ClientParameters")
.getter(getter(CreateConnectionOAuthRequestParameters::clientParameters)).setter(setter(Builder::clientParameters))
.constructor(CreateConnectionOAuthClientRequestParameters::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClientParameters").build()).build();
private static final SdkField AUTHORIZATION_ENDPOINT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AuthorizationEndpoint").getter(getter(CreateConnectionOAuthRequestParameters::authorizationEndpoint))
.setter(setter(Builder::authorizationEndpoint))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AuthorizationEndpoint").build())
.build();
private static final SdkField HTTP_METHOD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("HttpMethod").getter(getter(CreateConnectionOAuthRequestParameters::httpMethodAsString))
.setter(setter(Builder::httpMethod))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("HttpMethod").build()).build();
private static final SdkField O_AUTH_HTTP_PARAMETERS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("OAuthHttpParameters")
.getter(getter(CreateConnectionOAuthRequestParameters::oAuthHttpParameters))
.setter(setter(Builder::oAuthHttpParameters)).constructor(ConnectionHttpParameters::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OAuthHttpParameters").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_PARAMETERS_FIELD,
AUTHORIZATION_ENDPOINT_FIELD, HTTP_METHOD_FIELD, O_AUTH_HTTP_PARAMETERS_FIELD));
private static final long serialVersionUID = 1L;
private final CreateConnectionOAuthClientRequestParameters clientParameters;
private final String authorizationEndpoint;
private final String httpMethod;
private final ConnectionHttpParameters oAuthHttpParameters;
private CreateConnectionOAuthRequestParameters(BuilderImpl builder) {
this.clientParameters = builder.clientParameters;
this.authorizationEndpoint = builder.authorizationEndpoint;
this.httpMethod = builder.httpMethod;
this.oAuthHttpParameters = builder.oAuthHttpParameters;
}
/**
*
* A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth
* authorization.
*
*
* @return A CreateConnectionOAuthClientRequestParameters object that contains the client parameters
* for OAuth authorization.
*/
public final CreateConnectionOAuthClientRequestParameters clientParameters() {
return clientParameters;
}
/**
*
* The URL to the authorization endpoint when OAuth is specified as the authorization type.
*
*
* @return The URL to the authorization endpoint when OAuth is specified as the authorization type.
*/
public final String authorizationEndpoint() {
return authorizationEndpoint;
}
/**
*
* The method to use for the authorization request.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #httpMethod} will
* return {@link ConnectionOAuthHttpMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #httpMethodAsString}.
*
*
* @return The method to use for the authorization request.
* @see ConnectionOAuthHttpMethod
*/
public final ConnectionOAuthHttpMethod httpMethod() {
return ConnectionOAuthHttpMethod.fromValue(httpMethod);
}
/**
*
* The method to use for the authorization request.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #httpMethod} will
* return {@link ConnectionOAuthHttpMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #httpMethodAsString}.
*
*
* @return The method to use for the authorization request.
* @see ConnectionOAuthHttpMethod
*/
public final String httpMethodAsString() {
return httpMethod;
}
/**
*
* A ConnectionHttpParameters object that contains details about the additional parameters to use for
* the connection.
*
*
* @return A ConnectionHttpParameters object that contains details about the additional parameters to
* use for the connection.
*/
public final ConnectionHttpParameters oAuthHttpParameters() {
return oAuthHttpParameters;
}
@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 + Objects.hashCode(clientParameters());
hashCode = 31 * hashCode + Objects.hashCode(authorizationEndpoint());
hashCode = 31 * hashCode + Objects.hashCode(httpMethodAsString());
hashCode = 31 * hashCode + Objects.hashCode(oAuthHttpParameters());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateConnectionOAuthRequestParameters)) {
return false;
}
CreateConnectionOAuthRequestParameters other = (CreateConnectionOAuthRequestParameters) obj;
return Objects.equals(clientParameters(), other.clientParameters())
&& Objects.equals(authorizationEndpoint(), other.authorizationEndpoint())
&& Objects.equals(httpMethodAsString(), other.httpMethodAsString())
&& Objects.equals(oAuthHttpParameters(), other.oAuthHttpParameters());
}
/**
* 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("CreateConnectionOAuthRequestParameters").add("ClientParameters", clientParameters())
.add("AuthorizationEndpoint", authorizationEndpoint()).add("HttpMethod", httpMethodAsString())
.add("OAuthHttpParameters", oAuthHttpParameters()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ClientParameters":
return Optional.ofNullable(clazz.cast(clientParameters()));
case "AuthorizationEndpoint":
return Optional.ofNullable(clazz.cast(authorizationEndpoint()));
case "HttpMethod":
return Optional.ofNullable(clazz.cast(httpMethodAsString()));
case "OAuthHttpParameters":
return Optional.ofNullable(clazz.cast(oAuthHttpParameters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateConnectionOAuthRequestParameters) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for
* OAuth authorization.
*
*
* @param clientParameters
* A CreateConnectionOAuthClientRequestParameters object that contains the client parameters
* for OAuth authorization.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clientParameters(CreateConnectionOAuthClientRequestParameters clientParameters);
/**
*
* A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for
* OAuth authorization.
*
* This is a convenience method that creates an instance of the
* {@link CreateConnectionOAuthClientRequestParameters.Builder} avoiding the need to create one manually via
* {@link CreateConnectionOAuthClientRequestParameters#builder()}.
*
*
* When the {@link Consumer} completes, {@link CreateConnectionOAuthClientRequestParameters.Builder#build()} is
* called immediately and its result is passed to
* {@link #clientParameters(CreateConnectionOAuthClientRequestParameters)}.
*
* @param clientParameters
* a consumer that will call methods on {@link CreateConnectionOAuthClientRequestParameters.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #clientParameters(CreateConnectionOAuthClientRequestParameters)
*/
default Builder clientParameters(Consumer clientParameters) {
return clientParameters(CreateConnectionOAuthClientRequestParameters.builder().applyMutation(clientParameters)
.build());
}
/**
*
* The URL to the authorization endpoint when OAuth is specified as the authorization type.
*
*
* @param authorizationEndpoint
* The URL to the authorization endpoint when OAuth is specified as the authorization type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authorizationEndpoint(String authorizationEndpoint);
/**
*
* The method to use for the authorization request.
*
*
* @param httpMethod
* The method to use for the authorization request.
* @see ConnectionOAuthHttpMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionOAuthHttpMethod
*/
Builder httpMethod(String httpMethod);
/**
*
* The method to use for the authorization request.
*
*
* @param httpMethod
* The method to use for the authorization request.
* @see ConnectionOAuthHttpMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionOAuthHttpMethod
*/
Builder httpMethod(ConnectionOAuthHttpMethod httpMethod);
/**
*
* A ConnectionHttpParameters object that contains details about the additional parameters to use
* for the connection.
*
*
* @param oAuthHttpParameters
* A ConnectionHttpParameters object that contains details about the additional parameters
* to use for the connection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder oAuthHttpParameters(ConnectionHttpParameters oAuthHttpParameters);
/**
*
* A ConnectionHttpParameters object that contains details about the additional parameters to use
* for the connection.
*
* This is a convenience method that creates an instance of the {@link ConnectionHttpParameters.Builder}
* avoiding the need to create one manually via {@link ConnectionHttpParameters#builder()}.
*
*
* When the {@link Consumer} completes, {@link ConnectionHttpParameters.Builder#build()} is called immediately
* and its result is passed to {@link #oAuthHttpParameters(ConnectionHttpParameters)}.
*
* @param oAuthHttpParameters
* a consumer that will call methods on {@link ConnectionHttpParameters.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #oAuthHttpParameters(ConnectionHttpParameters)
*/
default Builder oAuthHttpParameters(Consumer oAuthHttpParameters) {
return oAuthHttpParameters(ConnectionHttpParameters.builder().applyMutation(oAuthHttpParameters).build());
}
}
static final class BuilderImpl implements Builder {
private CreateConnectionOAuthClientRequestParameters clientParameters;
private String authorizationEndpoint;
private String httpMethod;
private ConnectionHttpParameters oAuthHttpParameters;
private BuilderImpl() {
}
private BuilderImpl(CreateConnectionOAuthRequestParameters model) {
clientParameters(model.clientParameters);
authorizationEndpoint(model.authorizationEndpoint);
httpMethod(model.httpMethod);
oAuthHttpParameters(model.oAuthHttpParameters);
}
public final CreateConnectionOAuthClientRequestParameters.Builder getClientParameters() {
return clientParameters != null ? clientParameters.toBuilder() : null;
}
public final void setClientParameters(CreateConnectionOAuthClientRequestParameters.BuilderImpl clientParameters) {
this.clientParameters = clientParameters != null ? clientParameters.build() : null;
}
@Override
public final Builder clientParameters(CreateConnectionOAuthClientRequestParameters clientParameters) {
this.clientParameters = clientParameters;
return this;
}
public final String getAuthorizationEndpoint() {
return authorizationEndpoint;
}
public final void setAuthorizationEndpoint(String authorizationEndpoint) {
this.authorizationEndpoint = authorizationEndpoint;
}
@Override
public final Builder authorizationEndpoint(String authorizationEndpoint) {
this.authorizationEndpoint = authorizationEndpoint;
return this;
}
public final String getHttpMethod() {
return httpMethod;
}
public final void setHttpMethod(String httpMethod) {
this.httpMethod = httpMethod;
}
@Override
public final Builder httpMethod(String httpMethod) {
this.httpMethod = httpMethod;
return this;
}
@Override
public final Builder httpMethod(ConnectionOAuthHttpMethod httpMethod) {
this.httpMethod(httpMethod == null ? null : httpMethod.toString());
return this;
}
public final ConnectionHttpParameters.Builder getOAuthHttpParameters() {
return oAuthHttpParameters != null ? oAuthHttpParameters.toBuilder() : null;
}
public final void setOAuthHttpParameters(ConnectionHttpParameters.BuilderImpl oAuthHttpParameters) {
this.oAuthHttpParameters = oAuthHttpParameters != null ? oAuthHttpParameters.build() : null;
}
@Override
public final Builder oAuthHttpParameters(ConnectionHttpParameters oAuthHttpParameters) {
this.oAuthHttpParameters = oAuthHttpParameters;
return this;
}
@Override
public CreateConnectionOAuthRequestParameters build() {
return new CreateConnectionOAuthRequestParameters(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}