Class GetPropertyValueRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.iottwinmaker.model.IoTTwinMakerRequest
-
- software.amazon.awssdk.services.iottwinmaker.model.GetPropertyValueRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetPropertyValueRequest.Builder,GetPropertyValueRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetPropertyValueRequest extends IoTTwinMakerRequest implements ToCopyableBuilder<GetPropertyValueRequest.Builder,GetPropertyValueRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetPropertyValueRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetPropertyValueRequest.Builderbuilder()StringcomponentName()The name of the component whose property values the operation returns.StringcomponentPath()This string specifies the path to the composite component, starting from the top-level component.StringcomponentTypeId()The ID of the component type whose property values the operation returns.StringentityId()The ID of the entity whose property values the operation returns.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasSelectedProperties()For responses, this returns true if the service returned a value for the SelectedProperties property.IntegermaxResults()The maximum number of results to return at one time.StringnextToken()The string that specifies the next page of results.StringpropertyGroupName()The property group name.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()List<String>selectedProperties()The properties whose values the operation returns.static Class<? extends GetPropertyValueRequest.Builder>serializableBuilderClass()TabularConditionstabularConditions()The tabular conditions.GetPropertyValueRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringworkspaceId()The ID of the workspace whose values the operation returns.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
componentName
public final String componentName()
The name of the component whose property values the operation returns.
- Returns:
- The name of the component whose property values the operation returns.
-
componentPath
public final String componentPath()
This string specifies the path to the composite component, starting from the top-level component.
- Returns:
- This string specifies the path to the composite component, starting from the top-level component.
-
componentTypeId
public final String componentTypeId()
The ID of the component type whose property values the operation returns.
- Returns:
- The ID of the component type whose property values the operation returns.
-
entityId
public final String entityId()
The ID of the entity whose property values the operation returns.
- Returns:
- The ID of the entity whose property values the operation returns.
-
hasSelectedProperties
public final boolean hasSelectedProperties()
For responses, this returns true if the service returned a value for the SelectedProperties 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.
-
selectedProperties
public final List<String> selectedProperties()
The properties whose values the operation returns.
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
hasSelectedProperties()method.- Returns:
- The properties whose values the operation returns.
-
workspaceId
public final String workspaceId()
The ID of the workspace whose values the operation returns.
- Returns:
- The ID of the workspace whose values the operation returns.
-
maxResults
public final Integer maxResults()
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
- Returns:
- The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
-
nextToken
public final String nextToken()
The string that specifies the next page of results.
- Returns:
- The string that specifies the next page of results.
-
propertyGroupName
public final String propertyGroupName()
The property group name.
- Returns:
- The property group name.
-
tabularConditions
public final TabularConditions tabularConditions()
The tabular conditions.
- Returns:
- The tabular conditions.
-
toBuilder
public GetPropertyValueRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetPropertyValueRequest.Builder,GetPropertyValueRequest>- Specified by:
toBuilderin classIoTTwinMakerRequest
-
builder
public static GetPropertyValueRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetPropertyValueRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-