Class ListResourceTelemetryRequest

    • Method Detail

      • resourceIdentifierPrefix

        public final String resourceIdentifierPrefix()

        A string used to filter resources which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.

        Returns:
        A string used to filter resources which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.
      • resourceTypes

        public final List<ResourceType> resourceTypes()

        A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the resources will be returned in the same order used 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 hasResourceTypes() method.

        Returns:
        A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the resources will be returned in the same order used in the request.
      • hasResourceTypes

        public final boolean hasResourceTypes()
        For responses, this returns true if the service returned a value for the ResourceTypes 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.
      • resourceTypesAsStrings

        public final List<String> resourceTypesAsStrings()

        A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the resources will be returned in the same order used 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 hasResourceTypes() method.

        Returns:
        A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the resources will be returned in the same order used in the request.
      • telemetryConfigurationState

        public final Map<TelemetryType,​TelemetryState> telemetryConfigurationState()

        A key-value pair to filter resources based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.

        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 hasTelemetryConfigurationState() method.

        Returns:
        A key-value pair to filter resources based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.
      • hasTelemetryConfigurationState

        public final boolean hasTelemetryConfigurationState()
        For responses, this returns true if the service returned a value for the TelemetryConfigurationState 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.
      • telemetryConfigurationStateAsStrings

        public final Map<String,​String> telemetryConfigurationStateAsStrings()

        A key-value pair to filter resources based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.

        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 hasTelemetryConfigurationState() method.

        Returns:
        A key-value pair to filter resources based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.
      • hasResourceTags

        public final boolean hasResourceTags()
        For responses, this returns true if the service returned a value for the ResourceTags 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.
      • resourceTags

        public final Map<String,​String> resourceTags()

        A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags?

        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 hasResourceTags() method.

        Returns:
        A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags?
      • maxResults

        public final Integer maxResults()

        A number field used to limit the number of results within the returned list.

        Returns:
        A number field used to limit the number of results within the returned list.
      • nextToken

        public final String nextToken()

        The token for the next set of items to return. A previous call generates this token.

        Returns:
        The token for the next set of items to return. A previous call generates this token.
      • 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