Class CreateStreamGroupResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateStreamGroupResponse.Builder,CreateStreamGroupResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringarn()The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions.A set of applications that this stream group is associated to.builder()final InstantA timestamp that indicates when this resource was created.final DefaultApplicationThe default Amazon GameLift Streams application that is associated with this stream group.final StringA descriptive label for the stream group.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final InstantThe time at which this stream group expires.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse.final booleanFor responses, this returns true if the service returned a value for the AssociatedApplications property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the LocationStates property.final Stringid()A unique ID value that is assigned to the resource when it's created.final InstantA timestamp that indicates when this resource was last updated.final List<LocationState> This value is the set of locations, including their name, current status, and capacities.static Class<? extends CreateStreamGroupResponse.Builder> final StreamGroupStatusstatus()The current status of the stream group resource.final StringThe current status of the stream group resource.final StreamGroupStatusReasonA short description of the reason that the stream group is inERRORstatus.final StringA short description of the reason that the stream group is inERRORstatus.final StreamClassThe target stream quality for the stream group.final StringThe target stream quality for the stream group.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.gameliftstreams.model.GameLiftStreamsResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is
arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].- Returns:
- The Amazon Resource Name
(ARN) that is assigned to the stream group resource and that uniquely identifies the group across all
Amazon Web Services Regions. Format is
arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID].
-
description
A descriptive label for the stream group.
- Returns:
- A descriptive label for the stream group.
-
defaultApplication
The default Amazon GameLift Streams application that is associated with this stream group.
- Returns:
- The default Amazon GameLift Streams application that is associated with this stream group.
-
hasLocationStates
public final boolean hasLocationStates()For responses, this returns true if the service returned a value for the LocationStates 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. -
locationStates
This value is the set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
-
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. -
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. -
ERROR: Amazon GameLift Streams failed to set up this location. TheStatusReasonfield describes the error. You can remove this location and try to add it again. -
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
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
hasLocationStates()method.- Returns:
- This value is the set of locations, including their name, current status, and capacities.
A location can be in one of the following states:
-
ACTIVATING: Amazon GameLift Streams is preparing the location. You cannot stream from, scale the capacity of, or remove this location yet. -
ACTIVE: The location is provisioned with initial capacity. You can now stream from, scale the capacity of, or remove this location. -
ERROR: Amazon GameLift Streams failed to set up this location. TheStatusReasonfield describes the error. You can remove this location and try to add it again. -
REMOVING: Amazon GameLift Streams is working to remove this location. This will release all provisioned capacity for this location in this stream group.
-
-
-
streamClass
The target stream quality for the stream group.
A stream class can be one of the following:
-
gen5n_win2022(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen5n_high(NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
-
Tenancy: Supports up to 2 concurrent stream sessions
-
-
gen5n_ultra(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen4n_win2022(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen4n_high(NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
-
Tenancy: Supports up to 2 concurrent stream sessions
-
-
gen4n_ultra(NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
If the service returns an enum value that is not available in the current SDK version,
streamClasswill returnStreamClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstreamClassAsString().- Returns:
- The target stream quality for the stream group.
A stream class can be one of the following:
-
gen5n_win2022(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen5n_high(NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
-
Tenancy: Supports up to 2 concurrent stream sessions
-
-
gen5n_ultra(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen4n_win2022(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen4n_high(NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
-
Tenancy: Supports up to 2 concurrent stream sessions
-
-
gen4n_ultra(NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
- See Also:
-
-
streamClassAsString
The target stream quality for the stream group.
A stream class can be one of the following:
-
gen5n_win2022(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen5n_high(NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
-
Tenancy: Supports up to 2 concurrent stream sessions
-
-
gen5n_ultra(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen4n_win2022(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen4n_high(NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
-
Tenancy: Supports up to 2 concurrent stream sessions
-
-
gen4n_ultra(NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
If the service returns an enum value that is not available in the current SDK version,
streamClasswill returnStreamClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstreamClassAsString().- Returns:
- The target stream quality for the stream group.
A stream class can be one of the following:
-
gen5n_win2022(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen5n_high(NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
-
Tenancy: Supports up to 2 concurrent stream sessions
-
-
gen5n_ultra(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Uses dedicated NVIDIA A10G Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen4n_win2022(NVIDIA, ultra) Supports applications with extremely high 3D scene complexity. Runs applications on Microsoft Windows Server 2022 Base and supports DirectX 12. Compatible with Unreal Engine versions up through 5.4, 32 and 64-bit applications, and anti-cheat technology. Uses NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
gen4n_high(NVIDIA, high) Supports applications with moderate to high 3D scene complexity. Uses NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
-
Tenancy: Supports up to 2 concurrent stream sessions
-
-
gen4n_ultra(NVIDIA, ultra) Supports applications with high 3D scene complexity. Uses dedicated NVIDIA T4 Tensor GPU.-
Reference resolution: 1080p
-
Reference frame rate: 60 fps
-
Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
-
Tenancy: Supports 1 concurrent stream session
-
-
- See Also:
-
-
id
A unique ID value that is assigned to the resource when it's created. Format example:
sg-1AB2C3De4.- Returns:
- A unique ID value that is assigned to the resource when it's created. Format example:
sg-1AB2C3De4.
-
status
The current status of the stream group resource. Possible statuses include the following:
-
ACTIVATING: The stream group is deploying and isn't ready to host streams. -
ACTIVE: The stream group is ready to host streams. -
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. -
DELETING: Amazon GameLift Streams is in the process of deleting the stream group. -
ERROR: An error occurred when the stream group deployed. SeeStatusReason(returned byCreateStreamGroup,GetStreamGroup, andUpdateStreamGroup) for more information. -
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value ofExpiresAt. Create a new stream group to resume streaming capabilities. -
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStreamGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the stream group resource. Possible statuses include the following:
-
ACTIVATING: The stream group is deploying and isn't ready to host streams. -
ACTIVE: The stream group is ready to host streams. -
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. -
DELETING: Amazon GameLift Streams is in the process of deleting the stream group. -
ERROR: An error occurred when the stream group deployed. SeeStatusReason(returned byCreateStreamGroup,GetStreamGroup, andUpdateStreamGroup) for more information. -
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value ofExpiresAt. Create a new stream group to resume streaming capabilities. -
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
-
- See Also:
-
-
statusAsString
The current status of the stream group resource. Possible statuses include the following:
-
ACTIVATING: The stream group is deploying and isn't ready to host streams. -
ACTIVE: The stream group is ready to host streams. -
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. -
DELETING: Amazon GameLift Streams is in the process of deleting the stream group. -
ERROR: An error occurred when the stream group deployed. SeeStatusReason(returned byCreateStreamGroup,GetStreamGroup, andUpdateStreamGroup) for more information. -
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value ofExpiresAt. Create a new stream group to resume streaming capabilities. -
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStreamGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the stream group resource. Possible statuses include the following:
-
ACTIVATING: The stream group is deploying and isn't ready to host streams. -
ACTIVE: The stream group is ready to host streams. -
ACTIVE_WITH_ERRORS: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. -
DELETING: Amazon GameLift Streams is in the process of deleting the stream group. -
ERROR: An error occurred when the stream group deployed. SeeStatusReason(returned byCreateStreamGroup,GetStreamGroup, andUpdateStreamGroup) for more information. -
EXPIRED: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value ofExpiresAt. Create a new stream group to resume streaming capabilities. -
UPDATING_LOCATIONS: One or more locations in the stream group are in the process of updating (either activating or deleting).
-
- See Also:
-
-
statusReason
A short description of the reason that the stream group is in
ERRORstatus. The possible reasons can be one of the following:-
internalError: The request can't process right now because of an issue with the server. Try again later. -
noAvailableInstances: Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
If the service returns an enum value that is not available in the current SDK version,
statusReasonwill returnStreamGroupStatusReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusReasonAsString().- Returns:
- A short description of the reason that the stream group is in
ERRORstatus. The possible reasons can be one of the following:-
internalError: The request can't process right now because of an issue with the server. Try again later. -
noAvailableInstances: Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
-
- See Also:
-
-
statusReasonAsString
A short description of the reason that the stream group is in
ERRORstatus. The possible reasons can be one of the following:-
internalError: The request can't process right now because of an issue with the server. Try again later. -
noAvailableInstances: Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
If the service returns an enum value that is not available in the current SDK version,
statusReasonwill returnStreamGroupStatusReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusReasonAsString().- Returns:
- A short description of the reason that the stream group is in
ERRORstatus. The possible reasons can be one of the following:-
internalError: The request can't process right now because of an issue with the server. Try again later. -
noAvailableInstances: Amazon GameLift Streams does not currently have enough available on-demand capacity to fulfill your request. Wait a few minutes and retry the request as capacity can shift frequently. You can also try to make the request using a different stream class or in another region.
-
- See Also:
-
-
lastUpdatedAt
A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601 format, such as:
2022-12-27T22:29:40+00:00(UTC).- Returns:
- A timestamp that indicates when this resource was last updated. Timestamps are expressed using in ISO8601
format, such as:
2022-12-27T22:29:40+00:00(UTC).
-
createdAt
A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as:
2022-12-27T22:29:40+00:00(UTC).- Returns:
- A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601
format, such as:
2022-12-27T22:29:40+00:00(UTC).
-
expiresAt
The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as:
2022-12-27T22:29:40+00:00(UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.- Returns:
- The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as:
2022-12-27T22:29:40+00:00(UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.
-
hasAssociatedApplications
public final boolean hasAssociatedApplications()For responses, this returns true if the service returned a value for the AssociatedApplications 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. -
associatedApplications
A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.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
hasAssociatedApplications()method.- Returns:
- A set of applications that this stream group is associated to. You can stream any of these applications
by using this stream group.
This value is a set of Amazon Resource Names (ARNs) that uniquely identify application resources. Example ARN:
arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateStreamGroupResponse.Builder,CreateStreamGroupResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
Description copied from class:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-