software.amazon.awssdk.services.sagemaker.model

Class DescribeHubContentResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeHubContentResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeHubContentResponse.Builder,DescribeHubContentResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeHubContentResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeHubContentResponse.Builder,DescribeHubContentResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeHubContentResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeHubContentResponse.Builder	builder()
Instant	creationTime() The date and time that hub content was created.
String	documentSchemaVersion() The document schema version for the hub content.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() The failure reason if importing hub content failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHubContentDependencies() For responses, this returns true if the service returned a value for the HubContentDependencies property.
boolean	hasHubContentSearchKeywords() For responses, this returns true if the service returned a value for the HubContentSearchKeywords property.
String	hubArn() The Amazon Resource Name (ARN) of the hub that contains the content.
String	hubContentArn() The Amazon Resource Name (ARN) of the hub content.
List<HubContentDependency>	hubContentDependencies() The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.
String	hubContentDescription() A description of the hub content.
String	hubContentDisplayName() The display name of the hub content.
String	hubContentDocument() The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.
String	hubContentMarkdown() A string that provides a description of the hub content.
String	hubContentName() The name of the hub content.
List<String>	hubContentSearchKeywords() The searchable keywords for the hub content.
HubContentStatus	hubContentStatus() The status of the hub content.
String	hubContentStatusAsString() The status of the hub content.
HubContentType	hubContentType() The type of hub content.
String	hubContentTypeAsString() The type of hub content.
String	hubContentVersion() The version of the hub content.
String	hubName() The name of the hub that contains the content.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeHubContentResponse.Builder>	serializableBuilderClass()
DescribeHubContentResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hubContentName

public final String hubContentName()

The name of the hub content.

Returns:

The name of the hub content.

hubContentArn

public final String hubContentArn()

The Amazon Resource Name (ARN) of the hub content.

Returns:

The Amazon Resource Name (ARN) of the hub content.

hubContentVersion

public final String hubContentVersion()

The version of the hub content.

Returns:

The version of the hub content.

hubContentType

public final HubContentType hubContentType()

The type of hub content.

If the service returns an enum value that is not available in the current SDK version, hubContentType will return HubContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hubContentTypeAsString().

Returns:

The type of hub content.

See Also:

HubContentType

hubContentTypeAsString

public final String hubContentTypeAsString()

The type of hub content.

If the service returns an enum value that is not available in the current SDK version, hubContentType will return HubContentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hubContentTypeAsString().

Returns:

The type of hub content.

See Also:

HubContentType

documentSchemaVersion

public final String documentSchemaVersion()

The document schema version for the hub content.

Returns:

The document schema version for the hub content.

hubName

public final String hubName()

The name of the hub that contains the content.

Returns:

The name of the hub that contains the content.

hubArn

public final String hubArn()

The Amazon Resource Name (ARN) of the hub that contains the content.

Returns:

The Amazon Resource Name (ARN) of the hub that contains the content.

hubContentDisplayName

public final String hubContentDisplayName()

The display name of the hub content.

Returns:

The display name of the hub content.

hubContentDescription

public final String hubContentDescription()

A description of the hub content.

Returns:

A description of the hub content.

hubContentMarkdown

public final String hubContentMarkdown()

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

Returns:

A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.

hubContentDocument

public final String hubContentDocument()

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

Returns:

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

hasHubContentSearchKeywords

public final boolean hasHubContentSearchKeywords()

For responses, this returns true if the service returned a value for the HubContentSearchKeywords property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

hubContentSearchKeywords

public final List<String> hubContentSearchKeywords()

The searchable keywords for the hub content.

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 hasHubContentSearchKeywords() method.

Returns:

The searchable keywords for the hub content.

hasHubContentDependencies

public final boolean hasHubContentDependencies()

For responses, this returns true if the service returned a value for the HubContentDependencies property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

hubContentDependencies

public final List<HubContentDependency> hubContentDependencies()

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

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 hasHubContentDependencies() method.

Returns:

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

hubContentStatus

public final HubContentStatus hubContentStatus()

The status of the hub content.

If the service returns an enum value that is not available in the current SDK version, hubContentStatus will return HubContentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hubContentStatusAsString().

Returns:

The status of the hub content.

See Also:

HubContentStatus

hubContentStatusAsString

public final String hubContentStatusAsString()

The status of the hub content.

If the service returns an enum value that is not available in the current SDK version, hubContentStatus will return HubContentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hubContentStatusAsString().

Returns:

The status of the hub content.

See Also:

HubContentStatus

failureReason

public final String failureReason()

The failure reason if importing hub content failed.

Returns:

The failure reason if importing hub content failed.

creationTime

public final Instant creationTime()

The date and time that hub content was created.

Returns:

The date and time that hub content was created.

toBuilder

public DescribeHubContentResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeHubContentResponse.Builder,DescribeHubContentResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeHubContentResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeHubContentResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo