Class ServiceSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ServiceSummary.Builder,
ServiceSummary>
A summary for the service as a response to ListServices
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The unique identifier of the application.final String
arn()
The Amazon Resource Name (ARN) of the service.static ServiceSummary.Builder
builder()
final String
The Amazon Web Services account ID of the service creator.final Instant
A timestamp that indicates when the service is created.final String
A description of the service.final ServiceEndpointType
The endpoint type of the service.final String
The endpoint type of the service.final String
The unique identifier of the environment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ErrorResponse
error()
Any error associated with the service resource.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final LambdaEndpointSummary
A summary of the configuration for the Lambda endpoint type.final Instant
A timestamp that indicates when the service was last updated.final String
name()
The name of the service.final String
The Amazon Web Services account ID of the service owner.static Class
<? extends ServiceSummary.Builder> final String
The unique identifier of the service.final ServiceState
state()
The current state of the service.final String
The current state of the service.tags()
The tags assigned to the service.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final UrlEndpointSummary
The summary of the configuration for the URL endpoint type.final String
vpcId()
The ID of the virtual private cloud (VPC).Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The unique identifier of the application.
- Returns:
- The unique identifier of the application.
-
arn
The Amazon Resource Name (ARN) of the service.
- Returns:
- The Amazon Resource Name (ARN) of the service.
-
createdByAccountId
The Amazon Web Services account ID of the service creator.
- Returns:
- The Amazon Web Services account ID of the service creator.
-
createdTime
A timestamp that indicates when the service is created.
- Returns:
- A timestamp that indicates when the service is created.
-
description
A description of the service.
- Returns:
- A description of the service.
-
endpointType
The endpoint type of the service.
If the service returns an enum value that is not available in the current SDK version,
endpointType
will returnServiceEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The endpoint type of the service.
- See Also:
-
endpointTypeAsString
The endpoint type of the service.
If the service returns an enum value that is not available in the current SDK version,
endpointType
will returnServiceEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The endpoint type of the service.
- See Also:
-
environmentId
The unique identifier of the environment.
- Returns:
- The unique identifier of the environment.
-
error
Any error associated with the service resource.
- Returns:
- Any error associated with the service resource.
-
lambdaEndpoint
A summary of the configuration for the Lambda endpoint type.
- Returns:
- A summary of the configuration for the Lambda endpoint type.
-
lastUpdatedTime
A timestamp that indicates when the service was last updated.
- Returns:
- A timestamp that indicates when the service was last updated.
-
name
The name of the service.
- Returns:
- The name of the service.
-
ownerAccountId
The Amazon Web Services account ID of the service owner.
- Returns:
- The Amazon Web Services account ID of the service owner.
-
serviceId
The unique identifier of the service.
- Returns:
- The unique identifier of the service.
-
state
The current state of the service.
If the service returns an enum value that is not available in the current SDK version,
state
will returnServiceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the service.
- See Also:
-
stateAsString
The current state of the service.
If the service returns an enum value that is not available in the current SDK version,
state
will returnServiceState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the service.
- See Also:
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
tags
The tags assigned to the service.
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
hasTags()
method.- Returns:
- The tags assigned to the service.
-
urlEndpoint
The summary of the configuration for the URL endpoint type.
- Returns:
- The summary of the configuration for the URL endpoint type.
-
vpcId
The ID of the virtual private cloud (VPC).
- Returns:
- The ID of the virtual private cloud (VPC).
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ServiceSummary.Builder,
ServiceSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-