software.amazon.awssdk.services.sagemaker.model.DescribeAppRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sagemaker Show documentation
Show all versions of sagemaker Show documentation
The AWS Java SDK for Amazon SageMaker module holds the client classes that are used for communicating
with Amazon SageMaker Service
/*
* 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.sagemaker.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 DescribeAppRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainId").getter(getter(DescribeAppRequest::domainId)).setter(setter(Builder::domainId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainId").build()).build();
private static final SdkField USER_PROFILE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserProfileName").getter(getter(DescribeAppRequest::userProfileName))
.setter(setter(Builder::userProfileName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserProfileName").build()).build();
private static final SdkField SPACE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SpaceName").getter(getter(DescribeAppRequest::spaceName)).setter(setter(Builder::spaceName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SpaceName").build()).build();
private static final SdkField APP_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AppType").getter(getter(DescribeAppRequest::appTypeAsString)).setter(setter(Builder::appType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AppType").build()).build();
private static final SdkField APP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AppName").getter(getter(DescribeAppRequest::appName)).setter(setter(Builder::appName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AppName").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_ID_FIELD,
USER_PROFILE_NAME_FIELD, SPACE_NAME_FIELD, APP_TYPE_FIELD, APP_NAME_FIELD));
private final String domainId;
private final String userProfileName;
private final String spaceName;
private final String appType;
private final String appName;
private DescribeAppRequest(BuilderImpl builder) {
super(builder);
this.domainId = builder.domainId;
this.userProfileName = builder.userProfileName;
this.spaceName = builder.spaceName;
this.appType = builder.appType;
this.appName = builder.appName;
}
/**
*
* The domain ID.
*
*
* @return The domain ID.
*/
public final String domainId() {
return domainId;
}
/**
*
* The user profile name. If this value is not set, then SpaceName must be set.
*
*
* @return The user profile name. If this value is not set, then SpaceName must be set.
*/
public final String userProfileName() {
return userProfileName;
}
/**
*
* The name of the space.
*
*
* @return The name of the space.
*/
public final String spaceName() {
return spaceName;
}
/**
*
* The type of app.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #appType} will
* return {@link AppType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #appTypeAsString}.
*
*
* @return The type of app.
* @see AppType
*/
public final AppType appType() {
return AppType.fromValue(appType);
}
/**
*
* The type of app.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #appType} will
* return {@link AppType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #appTypeAsString}.
*
*
* @return The type of app.
* @see AppType
*/
public final String appTypeAsString() {
return appType;
}
/**
*
* The name of the app.
*
*
* @return The name of the app.
*/
public final String appName() {
return appName;
}
@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(domainId());
hashCode = 31 * hashCode + Objects.hashCode(userProfileName());
hashCode = 31 * hashCode + Objects.hashCode(spaceName());
hashCode = 31 * hashCode + Objects.hashCode(appTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(appName());
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 DescribeAppRequest)) {
return false;
}
DescribeAppRequest other = (DescribeAppRequest) obj;
return Objects.equals(domainId(), other.domainId()) && Objects.equals(userProfileName(), other.userProfileName())
&& Objects.equals(spaceName(), other.spaceName()) && Objects.equals(appTypeAsString(), other.appTypeAsString())
&& Objects.equals(appName(), other.appName());
}
/**
* 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("DescribeAppRequest").add("DomainId", domainId()).add("UserProfileName", userProfileName())
.add("SpaceName", spaceName()).add("AppType", appTypeAsString()).add("AppName", appName()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DomainId":
return Optional.ofNullable(clazz.cast(domainId()));
case "UserProfileName":
return Optional.ofNullable(clazz.cast(userProfileName()));
case "SpaceName":
return Optional.ofNullable(clazz.cast(spaceName()));
case "AppType":
return Optional.ofNullable(clazz.cast(appTypeAsString()));
case "AppName":
return Optional.ofNullable(clazz.cast(appName()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeAppRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The domain ID.
*
*
* @param domainId
* The domain ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainId(String domainId);
/**
*
* The user profile name. If this value is not set, then SpaceName must be set.
*
*
* @param userProfileName
* The user profile name. If this value is not set, then SpaceName must be set.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userProfileName(String userProfileName);
/**
*
* The name of the space.
*
*
* @param spaceName
* The name of the space.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder spaceName(String spaceName);
/**
*
* The type of app.
*
*
* @param appType
* The type of app.
* @see AppType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppType
*/
Builder appType(String appType);
/**
*
* The type of app.
*
*
* @param appType
* The type of app.
* @see AppType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AppType
*/
Builder appType(AppType appType);
/**
*
* The name of the app.
*
*
* @param appName
* The name of the app.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder appName(String appName);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String domainId;
private String userProfileName;
private String spaceName;
private String appType;
private String appName;
private BuilderImpl() {
}
private BuilderImpl(DescribeAppRequest model) {
super(model);
domainId(model.domainId);
userProfileName(model.userProfileName);
spaceName(model.spaceName);
appType(model.appType);
appName(model.appName);
}
public final String getDomainId() {
return domainId;
}
public final void setDomainId(String domainId) {
this.domainId = domainId;
}
@Override
public final Builder domainId(String domainId) {
this.domainId = domainId;
return this;
}
public final String getUserProfileName() {
return userProfileName;
}
public final void setUserProfileName(String userProfileName) {
this.userProfileName = userProfileName;
}
@Override
public final Builder userProfileName(String userProfileName) {
this.userProfileName = userProfileName;
return this;
}
public final String getSpaceName() {
return spaceName;
}
public final void setSpaceName(String spaceName) {
this.spaceName = spaceName;
}
@Override
public final Builder spaceName(String spaceName) {
this.spaceName = spaceName;
return this;
}
public final String getAppType() {
return appType;
}
public final void setAppType(String appType) {
this.appType = appType;
}
@Override
public final Builder appType(String appType) {
this.appType = appType;
return this;
}
@Override
public final Builder appType(AppType appType) {
this.appType(appType == null ? null : appType.toString());
return this;
}
public final String getAppName() {
return appName;
}
public final void setAppName(String appName) {
this.appName = appName;
}
@Override
public final Builder appName(String appName) {
this.appName = appName;
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 DescribeAppRequest build() {
return new DescribeAppRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy