software.amazon.awssdk.services.mediaconvert.model.UpdateQueueRequest Maven / Gradle / Ivy
Show all versions of mediaconvert 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.mediaconvert.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 UpdateQueueRequest extends MediaConvertRequest implements
ToCopyableBuilder {
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(UpdateQueueRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("description").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(UpdateQueueRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("name").build()).build();
private static final SdkField RESERVATION_PLAN_SETTINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ReservationPlanSettings")
.getter(getter(UpdateQueueRequest::reservationPlanSettings)).setter(setter(Builder::reservationPlanSettings))
.constructor(ReservationPlanSettings::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("reservationPlanSettings").build())
.build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(UpdateQueueRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DESCRIPTION_FIELD, NAME_FIELD,
RESERVATION_PLAN_SETTINGS_FIELD, STATUS_FIELD));
private final String description;
private final String name;
private final ReservationPlanSettings reservationPlanSettings;
private final String status;
private UpdateQueueRequest(BuilderImpl builder) {
super(builder);
this.description = builder.description;
this.name = builder.name;
this.reservationPlanSettings = builder.reservationPlanSettings;
this.status = builder.status;
}
/**
* The new description for the queue, if you are changing it.
*
* @return The new description for the queue, if you are changing it.
*/
public final String description() {
return description;
}
/**
* The name of the queue that you are modifying.
*
* @return The name of the queue that you are modifying.
*/
public final String name() {
return name;
}
/**
* The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an
* expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the
* number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make
* these commitments, you can't cancel them.
*
* @return The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to
* replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue
* by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add
* capacity. After you make these commitments, you can't cancel them.
*/
public final ReservationPlanSettings reservationPlanSettings() {
return reservationPlanSettings;
}
/**
* Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that
* queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in
* an error.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link QueueStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in
* that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish
* or result in an error.
* @see QueueStatus
*/
public final QueueStatus status() {
return QueueStatus.fromValue(status);
}
/**
* Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that
* queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in
* an error.
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link QueueStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in
* that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish
* or result in an error.
* @see QueueStatus
*/
public final String statusAsString() {
return status;
}
@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(description());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(reservationPlanSettings());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
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 UpdateQueueRequest)) {
return false;
}
UpdateQueueRequest other = (UpdateQueueRequest) obj;
return Objects.equals(description(), other.description()) && Objects.equals(name(), other.name())
&& Objects.equals(reservationPlanSettings(), other.reservationPlanSettings())
&& Objects.equals(statusAsString(), other.statusAsString());
}
/**
* 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("UpdateQueueRequest").add("Description", description()).add("Name", name())
.add("ReservationPlanSettings", reservationPlanSettings()).add("Status", statusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "ReservationPlanSettings":
return Optional.ofNullable(clazz.cast(reservationPlanSettings()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateQueueRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends MediaConvertRequest.Builder, SdkPojo, CopyableBuilder {
/**
* The new description for the queue, if you are changing it.
*
* @param description
* The new description for the queue, if you are changing it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
* The name of the queue that you are modifying.
*
* @param name
* The name of the queue that you are modifying.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
* The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace
* an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing
* the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you
* make these commitments, you can't cancel them.
*
* @param reservationPlanSettings
* The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to
* replace an expired one, you enter into another 12-month commitment. When you add capacity to your
* queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when
* you add capacity. After you make these commitments, you can't cancel them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reservationPlanSettings(ReservationPlanSettings reservationPlanSettings);
/**
* The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace
* an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing
* the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you
* make these commitments, you can't cancel them. This is a convenience method that creates an instance of the
* {@link ReservationPlanSettings.Builder} avoiding the need to create one manually via
* {@link ReservationPlanSettings#builder()}.
*
*
* When the {@link Consumer} completes, {@link ReservationPlanSettings.Builder#build()} is called immediately
* and its result is passed to {@link #reservationPlanSettings(ReservationPlanSettings)}.
*
* @param reservationPlanSettings
* a consumer that will call methods on {@link ReservationPlanSettings.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #reservationPlanSettings(ReservationPlanSettings)
*/
default Builder reservationPlanSettings(Consumer reservationPlanSettings) {
return reservationPlanSettings(ReservationPlanSettings.builder().applyMutation(reservationPlanSettings).build());
}
/**
* Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in
* that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or
* result in an error.
*
* @param status
* Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs
* in that queue won't begin. Jobs that are running when you pause the queue continue to run until they
* finish or result in an error.
* @see QueueStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see QueueStatus
*/
Builder status(String status);
/**
* Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in
* that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or
* result in an error.
*
* @param status
* Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs
* in that queue won't begin. Jobs that are running when you pause the queue continue to run until they
* finish or result in an error.
* @see QueueStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see QueueStatus
*/
Builder status(QueueStatus status);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends MediaConvertRequest.BuilderImpl implements Builder {
private String description;
private String name;
private ReservationPlanSettings reservationPlanSettings;
private String status;
private BuilderImpl() {
}
private BuilderImpl(UpdateQueueRequest model) {
super(model);
description(model.description);
name(model.name);
reservationPlanSettings(model.reservationPlanSettings);
status(model.status);
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final ReservationPlanSettings.Builder getReservationPlanSettings() {
return reservationPlanSettings != null ? reservationPlanSettings.toBuilder() : null;
}
public final void setReservationPlanSettings(ReservationPlanSettings.BuilderImpl reservationPlanSettings) {
this.reservationPlanSettings = reservationPlanSettings != null ? reservationPlanSettings.build() : null;
}
@Override
public final Builder reservationPlanSettings(ReservationPlanSettings reservationPlanSettings) {
this.reservationPlanSettings = reservationPlanSettings;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(QueueStatus status) {
this.status(status == null ? null : status.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 UpdateQueueRequest build() {
return new UpdateQueueRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}