software.amazon.awssdk.services.apprunner.model

Class ServiceSummary

java.lang.Object

software.amazon.awssdk.services.apprunner.model.ServiceSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ServiceSummary.Builder,ServiceSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class ServiceSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ServiceSummary.Builder,ServiceSummary>

Provides summary information for an App Runner service.

This type contains limited information about a service. It doesn't include configuration details. It's returned by the ListServices action. Complete service information is returned by the CreateService, DescribeService, and DeleteService actions using the Service type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ServiceSummary.Builder

Method Summary

Modifier and Type	Method and Description
static ServiceSummary.Builder	builder()
Instant	createdAt() The time when the App Runner service was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceSummary.Builder>	serializableBuilderClass()
String	serviceArn() The Amazon Resource Name (ARN) of this service.
String	serviceId() An ID that App Runner generated for this service.
String	serviceName() The customer-provided service name.
String	serviceUrl() A subdomain URL that App Runner generated for this service.
ServiceStatus	status() The current state of the App Runner service.
String	statusAsString() The current state of the App Runner service.
ServiceSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updatedAt() The time when the App Runner service was last updated.

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

serviceName

public final String serviceName()

The customer-provided service name.

Returns:

The customer-provided service name.

serviceId

public final String serviceId()

An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

Returns:

An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region.

serviceArn

public final String serviceArn()

The Amazon Resource Name (ARN) of this service.

Returns:

The Amazon Resource Name (ARN) of this service.

serviceUrl

public final String serviceUrl()

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

Returns:

A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application.

createdAt

public final Instant createdAt()

The time when the App Runner service was created. It's in the Unix time stamp format.

Returns:

The time when the App Runner service was created. It's in the Unix time stamp format.

updatedAt

public final Instant updatedAt()

The time when the App Runner service was last updated. It's in theUnix time stamp format.

Returns:

The time when the App Runner service was last updated. It's in theUnix time stamp format.

status

public final ServiceStatus status()

The current state of the App Runner service. These particular values mean the following.

• CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

• DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

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

Returns:

The current state of the App Runner service. These particular values mean the following.

• CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

• DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

See Also:

ServiceStatus

statusAsString

public final String statusAsString()

The current state of the App Runner service. These particular values mean the following.

• CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

• DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

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

Returns:

The current state of the App Runner service. These particular values mean the following.

• CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. To troubleshoot this failure, read the failure events and logs, change any parameters that need to be fixed, and rebuild your service using UpdateService.

• DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure that all related resources are removed.

See Also:

ServiceStatus

toBuilder

public ServiceSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceSummary.Builder,ServiceSummary>

builder

public static ServiceSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo