Package software.amazon.awssdk.services.kinesisvideo.model

Class DescribeEdgeConfigurationResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kinesisvideo.model.KinesisVideoResponse

software.amazon.awssdk.services.kinesisvideo.model.DescribeEdgeConfigurationResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEdgeConfigurationResponse.Builder,DescribeEdgeConfigurationResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeEdgeConfigurationResponse
extends KinesisVideoResponse
implements ToCopyableBuilder<DescribeEdgeConfigurationResponse.Builder,DescribeEdgeConfigurationResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeEdgeConfigurationResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeEdgeConfigurationResponse.Builder	builder()
Instant	creationTime()	The timestamp at which a stream’s edge configuration was first created.
EdgeAgentStatus	edgeAgentStatus()	An object that contains the latest status details for an edge agent's recorder and uploader jobs.
EdgeConfig	edgeConfig()	A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failedStatusDetails()	A description of the generated failure status.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedTime()	The timestamp at which a stream’s edge configuration was last updated.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEdgeConfigurationResponse.Builder>	serializableBuilderClass()
String	streamARN()	The Amazon Resource Name (ARN) of the stream.
String	streamName()	The name of the stream from which the edge configuration was updated.
SyncStatus	syncStatus()	The latest status of the edge configuration update.
String	syncStatusAsString()	The latest status of the edge configuration update.
DescribeEdgeConfigurationResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kinesisvideo.model.KinesisVideoResponse

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

streamName

public final String streamName()

The name of the stream from which the edge configuration was updated.

Returns:

The name of the stream from which the edge configuration was updated.

streamARN

public final String streamARN()

The Amazon Resource Name (ARN) of the stream.

Returns:

The Amazon Resource Name (ARN) of the stream.

creationTime

public final Instant creationTime()

The timestamp at which a stream’s edge configuration was first created.

Returns:

The timestamp at which a stream’s edge configuration was first created.

lastUpdatedTime

public final Instant lastUpdatedTime()

The timestamp at which a stream’s edge configuration was last updated.

Returns:

The timestamp at which a stream’s edge configuration was last updated.

syncStatus

public final SyncStatus syncStatus()

The latest status of the edge configuration update.

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

Returns:

The latest status of the edge configuration update.

See Also:

SyncStatus

syncStatusAsString

public final String syncStatusAsString()

The latest status of the edge configuration update.

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

Returns:

The latest status of the edge configuration update.

See Also:

SyncStatus

failedStatusDetails

public final String failedStatusDetails()

A description of the generated failure status.

Returns:

A description of the generated failure status.

edgeConfig

public final EdgeConfig edgeConfig()

A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

Returns:

A description of the stream's edge configuration that will be used to sync with the Edge Agent IoT Greengrass component. The Edge Agent component will run on an IoT Hub Device setup at your premise.

edgeAgentStatus

public final EdgeAgentStatus edgeAgentStatus()

An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent.

Returns:

An object that contains the latest status details for an edge agent's recorder and uploader jobs. Use this information to determine the current health of an edge agent.

toBuilder

public DescribeEdgeConfigurationResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEdgeConfigurationResponse.Builder,DescribeEdgeConfigurationResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeEdgeConfigurationResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeEdgeConfigurationResponse.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