software.amazon.awssdk.services.pinpoint.model.GetPushTemplateRequest Maven / Gradle / Ivy
Show all versions of pinpoint 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.pinpoint.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 GetPushTemplateRequest extends PinpointRequest implements
ToCopyableBuilder {
private static final SdkField TEMPLATE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateName").getter(getter(GetPushTemplateRequest::templateName))
.setter(setter(Builder::templateName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("template-name").build()).build();
private static final SdkField VERSION_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Version")
.getter(getter(GetPushTemplateRequest::version)).setter(setter(Builder::version))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("version").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TEMPLATE_NAME_FIELD,
VERSION_FIELD));
private final String templateName;
private final String version;
private GetPushTemplateRequest(BuilderImpl builder) {
super(builder);
this.templateName = builder.templateName;
this.version = builder.version;
}
/**
*
* The name of the message template. A template name must start with an alphanumeric character and can contain a
* maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-).
* Template names are case sensitive.
*
*
* @return The name of the message template. A template name must start with an alphanumeric character and can
* contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or
* hyphens (-). Template names are case sensitive.
*/
public final String templateName() {
return templateName;
}
/**
*
* The unique identifier for the version of the message template to update, retrieve information about, or delete.
* To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
*
*
* If specified, this value must match the identifier for an existing template version. If specified for an update
* operation, this value must match the identifier for the latest existing version of the template. This restriction
* helps ensure that race conditions don't occur.
*
*
* If you don't specify a value for this parameter, Amazon Pinpoint does the following:
*
*
* -
*
* For a get operation, retrieves information about the active version of the template.
*
*
* -
*
* For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the
* create-new-version parameter isn't used or is set to false.
*
*
* -
*
* For a delete operation, deletes the template, including all versions of the template.
*
*
*
*
* @return The unique identifier for the version of the message template to update, retrieve information about, or
* delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
*
* If specified, this value must match the identifier for an existing template version. If specified for an
* update operation, this value must match the identifier for the latest existing version of the template.
* This restriction helps ensure that race conditions don't occur.
*
*
* If you don't specify a value for this parameter, Amazon Pinpoint does the following:
*
*
* -
*
* For a get operation, retrieves information about the active version of the template.
*
*
* -
*
* For an update operation, saves the updates to (overwrites) the latest existing version of the template,
* if the create-new-version parameter isn't used or is set to false.
*
*
* -
*
* For a delete operation, deletes the template, including all versions of the template.
*
*
*/
public final String version() {
return version;
}
@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(templateName());
hashCode = 31 * hashCode + Objects.hashCode(version());
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 GetPushTemplateRequest)) {
return false;
}
GetPushTemplateRequest other = (GetPushTemplateRequest) obj;
return Objects.equals(templateName(), other.templateName()) && Objects.equals(version(), other.version());
}
/**
* 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("GetPushTemplateRequest").add("TemplateName", templateName()).add("Version", version()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TemplateName":
return Optional.ofNullable(clazz.cast(templateName()));
case "Version":
return Optional.ofNullable(clazz.cast(version()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetPushTemplateRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PinpointRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the message template. A template name must start with an alphanumeric character and can contain a
* maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-).
* Template names are case sensitive.
*
*
* @param templateName
* The name of the message template. A template name must start with an alphanumeric character and can
* contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_),
* or hyphens (-). Template names are case sensitive.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateName(String templateName);
/**
*
* The unique identifier for the version of the message template to update, retrieve information about, or
* delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource.
*
*
* If specified, this value must match the identifier for an existing template version. If specified for an
* update operation, this value must match the identifier for the latest existing version of the template. This
* restriction helps ensure that race conditions don't occur.
*
*
* If you don't specify a value for this parameter, Amazon Pinpoint does the following:
*
*
* -
*
* For a get operation, retrieves information about the active version of the template.
*
*
* -
*
* For an update operation, saves the updates to (overwrites) the latest existing version of the template, if
* the create-new-version parameter isn't used or is set to false.
*
*
* -
*
* For a delete operation, deletes the template, including all versions of the template.
*
*
*
*
* @param version
* The unique identifier for the version of the message template to update, retrieve information about,
* or delete. To retrieve identifiers and other information for all the versions of a template, use the
* Template Versions resource.
*
* If specified, this value must match the identifier for an existing template version. If specified for
* an update operation, this value must match the identifier for the latest existing version of the
* template. This restriction helps ensure that race conditions don't occur.
*
*
* If you don't specify a value for this parameter, Amazon Pinpoint does the following:
*
*
* -
*
* For a get operation, retrieves information about the active version of the template.
*
*
* -
*
* For an update operation, saves the updates to (overwrites) the latest existing version of the
* template, if the create-new-version parameter isn't used or is set to false.
*
*
* -
*
* For a delete operation, deletes the template, including all versions of the template.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder version(String version);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends PinpointRequest.BuilderImpl implements Builder {
private String templateName;
private String version;
private BuilderImpl() {
}
private BuilderImpl(GetPushTemplateRequest model) {
super(model);
templateName(model.templateName);
version(model.version);
}
public final String getTemplateName() {
return templateName;
}
public final void setTemplateName(String templateName) {
this.templateName = templateName;
}
@Override
public final Builder templateName(String templateName) {
this.templateName = templateName;
return this;
}
public final String getVersion() {
return version;
}
public final void setVersion(String version) {
this.version = version;
}
@Override
public final Builder version(String version) {
this.version = version;
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 GetPushTemplateRequest build() {
return new GetPushTemplateRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}