Class GetBrowserSessionResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetBrowserSessionResponse.Builder,GetBrowserSessionResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe identifier of the browser.builder()final InstantThe time at which the browser session was created.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List<BrowserExtension> The list of browser extensions that are configured in the browser session.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 Extensions property.final inthashCode()final InstantThe time at which the browser session was last updated.final Stringname()The name of the browser session.The browser profile configuration associated with this session.static Class<? extends GetBrowserSessionResponse.Builder> final StringThe identifier of the browser session.final StringThe artifact containing the session replay information.final IntegerThe timeout period for the browser session in seconds.final BrowserSessionStatusstatus()The current status of the browser session.final StringThe current status of the browser session.final BrowserSessionStreamstreams()The streams associated with this browser session.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.final ViewPortviewPort()Returns the value of the ViewPort property for this object.Methods inherited from class software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
browserIdentifier
The identifier of the browser.
- Returns:
- The identifier of the browser.
-
sessionId
The identifier of the browser session.
- Returns:
- The identifier of the browser session.
-
name
The name of the browser session.
- Returns:
- The name of the browser session.
-
createdAt
The time at which the browser session was created.
- Returns:
- The time at which the browser session was created.
-
viewPort
Returns the value of the ViewPort property for this object.- Returns:
- The value of the ViewPort property for this object.
-
hasExtensions
public final boolean hasExtensions()For responses, this returns true if the service returned a value for the Extensions 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. -
extensions
The list of browser extensions that are configured in the browser session.
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
hasExtensions()method.- Returns:
- The list of browser extensions that are configured in the browser session.
-
profileConfiguration
The browser profile configuration associated with this session. Contains the profile identifier that links to persistent browser data such as cookies and local storage.
- Returns:
- The browser profile configuration associated with this session. Contains the profile identifier that links to persistent browser data such as cookies and local storage.
-
sessionTimeoutSeconds
The timeout period for the browser session in seconds.
- Returns:
- The timeout period for the browser session in seconds.
-
status
The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnBrowserSessionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
- See Also:
-
statusAsString
The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnBrowserSessionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the browser session. Possible values include ACTIVE, STOPPING, and STOPPED.
- See Also:
-
streams
The streams associated with this browser session. These include the automation stream and live view stream.
- Returns:
- The streams associated with this browser session. These include the automation stream and live view stream.
-
sessionReplayArtifact
The artifact containing the session replay information.
- Returns:
- The artifact containing the session replay information.
-
lastUpdatedAt
The time at which the browser session was last updated.
- Returns:
- The time at which the browser session was last updated.
-
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<GetBrowserSessionResponse.Builder,GetBrowserSessionResponse> - 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.
-