software.amazon.awssdk.services.ecs.model.FirelensConfiguration Maven / Gradle / Ivy
Show all versions of ecs 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.ecs.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The FireLens configuration for the container. This is used to specify and configure a log router for container logs.
* For more information, see Custom Log Routing in the
* Amazon Elastic Container Service Developer Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class FirelensConfiguration implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("type")
.getter(getter(FirelensConfiguration::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final SdkField> OPTIONS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("options")
.getter(getter(FirelensConfiguration::options))
.setter(setter(Builder::options))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("options").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TYPE_FIELD, OPTIONS_FIELD));
private static final long serialVersionUID = 1L;
private final String type;
private final Map options;
private FirelensConfiguration(BuilderImpl builder) {
this.type = builder.type;
this.options = builder.options;
}
/**
*
* The log router to use. The valid values are fluentd or fluentbit.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link FirelensConfigurationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The log router to use. The valid values are fluentd or fluentbit.
* @see FirelensConfigurationType
*/
public final FirelensConfigurationType type() {
return FirelensConfigurationType.fromValue(type);
}
/**
*
* The log router to use. The valid values are fluentd or fluentbit.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link FirelensConfigurationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The log router to use. The valid values are fluentd or fluentbit.
* @see FirelensConfigurationType
*/
public final String typeAsString() {
return type;
}
/**
* For responses, this returns true if the service returned a value for the Options property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasOptions() {
return options != null && !(options instanceof SdkAutoConstructMap);
}
/**
*
* The options to use when configuring the log router. This field is optional and can be used to specify a custom
* configuration file or to add additional metadata, such as the task, task definition, cluster, and container
* instance details to the log event. If specified, the syntax to use is
* "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
* . For more information, see Creating
* a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer
* Guide.
*
*
*
* Tasks hosted on Fargate only support the file configuration file type.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasOptions} method.
*
*
* @return The options to use when configuring the log router. This field is optional and can be used to specify a
* custom configuration file or to add additional metadata, such as the task, task definition, cluster, and
* container instance details to the log event. If specified, the syntax to use is
* "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
* . For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container
* Service Developer Guide.
*
* Tasks hosted on Fargate only support the file configuration file type.
*
*/
public final Map options() {
return options;
}
@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(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasOptions() ? options() : null);
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 FirelensConfiguration)) {
return false;
}
FirelensConfiguration other = (FirelensConfiguration) obj;
return Objects.equals(typeAsString(), other.typeAsString()) && hasOptions() == other.hasOptions()
&& Objects.equals(options(), other.options());
}
/**
* 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("FirelensConfiguration").add("Type", typeAsString())
.add("Options", hasOptions() ? options() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "options":
return Optional.ofNullable(clazz.cast(options()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((FirelensConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The log router to use. The valid values are fluentd or fluentbit.
*
*
* @param type
* The log router to use. The valid values are fluentd or fluentbit.
* @see FirelensConfigurationType
* @return Returns a reference to this object so that method calls can be chained together.
* @see FirelensConfigurationType
*/
Builder type(String type);
/**
*
* The log router to use. The valid values are fluentd or fluentbit.
*
*
* @param type
* The log router to use. The valid values are fluentd or fluentbit.
* @see FirelensConfigurationType
* @return Returns a reference to this object so that method calls can be chained together.
* @see FirelensConfigurationType
*/
Builder type(FirelensConfigurationType type);
/**
*
* The options to use when configuring the log router. This field is optional and can be used to specify a
* custom configuration file or to add additional metadata, such as the task, task definition, cluster, and
* container instance details to the log event. If specified, the syntax to use is
* "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
* . For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service
* Developer Guide.
*
*
*
* Tasks hosted on Fargate only support the file configuration file type.
*
*
*
* @param options
* The options to use when configuring the log router. This field is optional and can be used to specify
* a custom configuration file or to add additional metadata, such as the task, task definition, cluster,
* and container instance details to the log event. If specified, the syntax to use is
* "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
* . For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container
* Service Developer Guide.
*
* Tasks hosted on Fargate only support the file configuration file type.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder options(Map options);
}
static final class BuilderImpl implements Builder {
private String type;
private Map options = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(FirelensConfiguration model) {
type(model.type);
options(model.options);
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(FirelensConfigurationType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final Map getOptions() {
if (options instanceof SdkAutoConstructMap) {
return null;
}
return options;
}
public final void setOptions(Map options) {
this.options = FirelensConfigurationOptionsMapCopier.copy(options);
}
@Override
public final Builder options(Map options) {
this.options = FirelensConfigurationOptionsMapCopier.copy(options);
return this;
}
@Override
public FirelensConfiguration build() {
return new FirelensConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}