software.amazon.awssdk.services.rds.model.ProcessorFeature Maven / Gradle / Ivy
Show all versions of rds 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.rds.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
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 processor features of a DB instance class.
*
*
* To specify the number of CPU cores, use the coreCount feature name for the Name parameter.
* To specify the number of threads per core, use the threadsPerCore feature name for the Name
* parameter.
*
*
* You can set the processor features of the DB instance class for a DB instance when you call one of the following
* actions:
*
*
* -
*
* CreateDBInstance
*
*
* -
*
* ModifyDBInstance
*
*
* -
*
* RestoreDBInstanceFromDBSnapshot
*
*
* -
*
* RestoreDBInstanceFromS3
*
*
* -
*
* RestoreDBInstanceToPointInTime
*
*
*
*
* You can view the valid processor values for a particular instance class by calling the
* DescribeOrderableDBInstanceOptions action and specifying the instance class for the
* DBInstanceClass parameter.
*
*
* In addition, you can use the following actions for DB instance class processor information:
*
*
* -
*
* DescribeDBInstances
*
*
* -
*
* DescribeDBSnapshots
*
*
* -
*
* DescribeValidDBInstanceModifications
*
*
*
*
* If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the
* following conditions are met:
*
*
* -
*
* You are accessing an Oracle DB instance.
*
*
* -
*
* Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
*
*
* -
*
* The current number CPU cores and threads is set to a non-default value.
*
*
*
*
* For more information, see
* Configuring the processor for a DB instance class in RDS for Oracle in the Amazon RDS User Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ProcessorFeature implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(ProcessorFeature::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Value")
.getter(getter(ProcessorFeature::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Value").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, VALUE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final String name;
private final String value;
private ProcessorFeature(BuilderImpl builder) {
this.name = builder.name;
this.value = builder.value;
}
/**
*
* The name of the processor feature. Valid names are coreCount and threadsPerCore.
*
*
* @return The name of the processor feature. Valid names are coreCount and threadsPerCore
* .
*/
public final String name() {
return name;
}
/**
*
* The value of a processor feature.
*
*
* @return The value of a processor feature.
*/
public final String value() {
return value;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(value());
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 ProcessorFeature)) {
return false;
}
ProcessorFeature other = (ProcessorFeature) obj;
return Objects.equals(name(), other.name()) && Objects.equals(value(), other.value());
}
/**
* 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("ProcessorFeature").add("Name", name()).add("Value", value()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Value":
return Optional.ofNullable(clazz.cast(value()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("Name", NAME_FIELD);
map.put("Value", VALUE_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ProcessorFeature) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the processor feature. Valid names are coreCount and threadsPerCore.
*
*
* @param name
* The name of the processor feature. Valid names are coreCount and
* threadsPerCore.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The value of a processor feature.
*
*
* @param value
* The value of a processor feature.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(String value);
}
static final class BuilderImpl implements Builder {
private String name;
private String value;
private BuilderImpl() {
}
private BuilderImpl(ProcessorFeature model) {
name(model.name);
value(model.value);
}
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 String getValue() {
return value;
}
public final void setValue(String value) {
this.value = value;
}
@Override
public final Builder value(String value) {
this.value = value;
return this;
}
@Override
public ProcessorFeature build() {
return new ProcessorFeature(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}