Class CreateFleetRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateFleetRequest.Builder,
CreateFleetRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AnywhereConfiguration
Amazon GameLift Anywhere configuration options.static CreateFleetRequest.Builder
builder()
final String
buildId()
The unique identifier for a custom game server build to be deployed on fleet instances.final CertificateConfiguration
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet.final ComputeType
The type of compute resource used to host your game servers.final String
The type of compute resource used to host your game servers.final String
A description for the fleet.final List
<IpPermission> The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet.final EC2InstanceType
The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances.final String
The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FleetType
Indicates whether to use On-Demand or Spot instances for this fleet.final String
Indicates whether to use On-Demand or Spot instances for this fleet.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the EC2InboundPermissions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Locations property.final boolean
For responses, this returns true if the service returned a value for the LogPaths property.final boolean
For responses, this returns true if the service returned a value for the MetricGroups property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
A unique identifier for an IAM role with access permissions to other Amazon Web Services services.Prompts Amazon GameLift to generate a shared credentials file for the IAM role defined inInstanceRoleArn
.final String
Prompts Amazon GameLift to generate a shared credentials file for the IAM role defined inInstanceRoleArn
.final List
<LocationConfiguration> A set of remote locations to deploy additional instances to and manage as part of the fleet.logPaths()
This parameter is no longer used. To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server APIProcessReady()
and specify one or more directory paths inlogParameters
.The name of an Amazon Web Services CloudWatch metric group to add this fleet to.final String
name()
A descriptive label that is associated with a fleet.final ProtectionPolicy
The status of termination protection for active game sessions on the fleet.final String
The status of termination protection for active game sessions on the fleet.final String
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC.final String
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.final RuntimeConfiguration
Instructions for how to launch and maintain server processes on instances in the fleet.final String
scriptId()
The unique identifier for a Realtime configuration script to be deployed on fleet instances.static Class
<? extends CreateFleetRequest.Builder> final String
This parameter is no longer used. Specify server launch parameters using theRuntimeConfiguration
parameter.final String
This parameter is no longer used. Specify a server launch path using theRuntimeConfiguration
parameter.tags()
A list of labels to assign to the new fleet resource.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
- Returns:
- A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
-
description
A description for the fleet.
- Returns:
- A description for the fleet.
-
buildId
The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in
READY
status. This fleet property can't be changed after the fleet is created.- Returns:
- The unique identifier for a custom game server build to be deployed on fleet instances. You can use
either the build ID or ARN. The build must be uploaded to Amazon GameLift and in
READY
status. This fleet property can't be changed after the fleet is created.
-
scriptId
The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be changed after the fleet is created.
- Returns:
- The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property can't be changed after the fleet is created.
-
serverLaunchPath
This parameter is no longer used. Specify a server launch path using the
RuntimeConfiguration
parameter. Requests that use this parameter instead continue to be valid.- Returns:
- This parameter is no longer used. Specify a server launch path using the
RuntimeConfiguration
parameter. Requests that use this parameter instead continue to be valid.
-
serverLaunchParameters
This parameter is no longer used. Specify server launch parameters using the
RuntimeConfiguration
parameter. Requests that use this parameter instead continue to be valid.- Returns:
- This parameter is no longer used. Specify server launch parameters using the
RuntimeConfiguration
parameter. Requests that use this parameter instead continue to be valid.
-
hasLogPaths
public final boolean hasLogPaths()For responses, this returns true if the service returned a value for the LogPaths 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. -
logPaths
This parameter is no longer used. To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API
ProcessReady()
and specify one or more directory paths inlogParameters
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.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
hasLogPaths()
method.- Returns:
- This parameter is no longer used. To specify where Amazon GameLift should store log files once a
server process shuts down, use the Amazon GameLift server API
ProcessReady()
and specify one or more directory paths inlogParameters
. For more information, see Initialize the server process in the Amazon GameLift Developer Guide.
-
ec2InstanceType
The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
If the service returns an enum value that is not available in the current SDK version,
ec2InstanceType
will returnEC2InstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromec2InstanceTypeAsString()
.- Returns:
- The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
- See Also:
-
ec2InstanceTypeAsString
The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
If the service returns an enum value that is not available in the current SDK version,
ec2InstanceType
will returnEC2InstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromec2InstanceTypeAsString()
.- Returns:
- The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions of Amazon EC2 instance types.
- See Also:
-
hasEc2InboundPermissions
public final boolean hasEc2InboundPermissions()For responses, this returns true if the service returned a value for the EC2InboundPermissions 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. -
ec2InboundPermissions
The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
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
hasEc2InboundPermissions()
method.- Returns:
- The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges.
-
newGameSessionProtectionPolicy
The status of termination protection for active game sessions on the fleet. By default, this property is set to
NoProtection
. You can also set game session protection for an individual game session by calling UpdateGameSession.-
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
-
FullProtection - Game sessions in
ACTIVE
status cannot be terminated during a scale-down event.
If the service returns an enum value that is not available in the current SDK version,
newGameSessionProtectionPolicy
will returnProtectionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnewGameSessionProtectionPolicyAsString()
.- Returns:
- The status of termination protection for active game sessions on the fleet. By default, this property is
set to
NoProtection
. You can also set game session protection for an individual game session by calling UpdateGameSession.-
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
-
FullProtection - Game sessions in
ACTIVE
status cannot be terminated during a scale-down event.
-
- See Also:
-
-
newGameSessionProtectionPolicyAsString
The status of termination protection for active game sessions on the fleet. By default, this property is set to
NoProtection
. You can also set game session protection for an individual game session by calling UpdateGameSession.-
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
-
FullProtection - Game sessions in
ACTIVE
status cannot be terminated during a scale-down event.
If the service returns an enum value that is not available in the current SDK version,
newGameSessionProtectionPolicy
will returnProtectionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnewGameSessionProtectionPolicyAsString()
.- Returns:
- The status of termination protection for active game sessions on the fleet. By default, this property is
set to
NoProtection
. You can also set game session protection for an individual game session by calling UpdateGameSession.-
NoProtection - Game sessions can be terminated during active gameplay as a result of a scale-down event.
-
FullProtection - Game sessions in
ACTIVE
status cannot be terminated during a scale-down event.
-
- See Also:
-
-
runtimeConfiguration
Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently.
The
RuntimeConfiguration
parameter is required unless the fleet is being configured using the older parametersServerLaunchPath
andServerLaunchParameters
, which are still supported for backward compatibility.- Returns:
- Instructions for how to launch and maintain server processes on instances in the fleet. The runtime
configuration defines one or more server process configurations, each identifying a build executable or
Realtime script file and the number of processes of that type to run concurrently.
The
RuntimeConfiguration
parameter is required unless the fleet is being configured using the older parametersServerLaunchPath
andServerLaunchParameters
, which are still supported for backward compatibility.
-
resourceCreationLimitPolicy
A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
- Returns:
- A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
-
hasMetricGroups
public final boolean hasMetricGroups()For responses, this returns true if the service returned a value for the MetricGroups 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. -
metricGroups
The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
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
hasMetricGroups()
method.- Returns:
- The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
-
peerVpcAwsAccountId
Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.
- Returns:
- Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings.
-
peerVpcId
A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
- Returns:
- A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the VPC Dashboard in the Amazon Web Services Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.
-
fleetType
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.If the service returns an enum value that is not available in the current SDK version,
fleetType
will returnFleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfleetTypeAsString()
.- Returns:
- Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created. - See Also:
-
fleetTypeAsString
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.If the service returns an enum value that is not available in the current SDK version,
fleetType
will returnFleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfleetTypeAsString()
.- Returns:
- Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND
. Learn more about when to use On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created. - See Also:
-
instanceRoleArn
A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be changed after the fleet is created.
- Returns:
- A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets. This fleet property can't be changed after the fleet is created.
-
certificateConfiguration
Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the
CertificateConfiguration
isDISABLED
. You can't change this property after you create the fleet.Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.
- Returns:
- Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the
certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By
default, the
CertificateConfiguration
isDISABLED
. You can't change this property after you create the fleet.Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.
ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see Supported Regions in the Certificate Manager User Guide.
-
hasLocations
public final boolean hasLocations()For responses, this returns true if the service returned a value for the Locations 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. -
locations
A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as
us-west-2
. To create a fleet with instances in the home Region only, don't use this parameter.To use this parameter, Amazon GameLift requires you to use your home location in the request.
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
hasLocations()
method.- Returns:
- A set of remote locations to deploy additional instances to and manage as part of the fleet. This
parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple
locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in
the form of an Amazon Web Services Region code such as
us-west-2
. To create a fleet with instances in the home Region only, don't use this parameter.To use this parameter, Amazon GameLift requires you to use your home location in the request.
-
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
A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
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:
- A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
-
computeType
The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift. By default, this property is set to
EC2
.If the service returns an enum value that is not available in the current SDK version,
computeType
will returnComputeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomputeTypeAsString()
.- Returns:
- The type of compute resource used to host your game servers. You can use your own compute resources with
Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift. By default, this
property is set to
EC2
. - See Also:
-
computeTypeAsString
The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift. By default, this property is set to
EC2
.If the service returns an enum value that is not available in the current SDK version,
computeType
will returnComputeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomputeTypeAsString()
.- Returns:
- The type of compute resource used to host your game servers. You can use your own compute resources with
Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift. By default, this
property is set to
EC2
. - See Also:
-
anywhereConfiguration
Amazon GameLift Anywhere configuration options.
- Returns:
- Amazon GameLift Anywhere configuration options.
-
instanceRoleCredentialsProvider
Prompts Amazon GameLift to generate a shared credentials file for the IAM role defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.If the service returns an enum value that is not available in the current SDK version,
instanceRoleCredentialsProvider
will returnInstanceRoleCredentialsProvider.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceRoleCredentialsProviderAsString()
.- Returns:
- Prompts Amazon GameLift to generate a shared credentials file for the IAM role defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. - See Also:
-
instanceRoleCredentialsProviderAsString
Prompts Amazon GameLift to generate a shared credentials file for the IAM role defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.If the service returns an enum value that is not available in the current SDK version,
instanceRoleCredentialsProvider
will returnInstanceRoleCredentialsProvider.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceRoleCredentialsProviderAsString()
.- Returns:
- Prompts Amazon GameLift to generate a shared credentials file for the IAM role defined in
InstanceRoleArn
. The shared credentials file is stored on each fleet instance and refreshed as needed. Use shared credentials for applications that are deployed along with the game server executable, if the game server is integrated with server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. - See Also:
-
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<CreateFleetRequest.Builder,
CreateFleetRequest> - Specified by:
toBuilder
in classGameLiftRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-