Class GetPropertyValueRequest

    • 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 the isEmpty() 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.
      • 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.
        Overrides:
        toString in class Object