Package com.inductiveautomation.ignition.gateway.config.actions

Interface ResourceAction.Read

All Superinterfaces:

ResourceAction

All Known Implementing Classes:

DefaultResourceActions.Read

Enclosing interface:

ResourceAction

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static non-sealed interface ResourceAction.Read
extends ResourceAction

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.config.actions.ResourceAction

ResourceAction.ContextObject, ResourceAction.Copy, ResourceAction.Create, ResourceAction.CreateRequest, ResourceAction.Delete, ResourceAction.DeleteRequest, ResourceAction.ListResources, ResourceAction.Modify, ResourceAction.ModifyRequest, ResourceAction.Move, ResourceAction.Read, ResourceAction.Rename

Method Summary

Modifier and Type	Method	Description
@NotNull ReadResponse	read(ConfigurationManager manager, ResourcePath path, @Nullable String collection)	Reads a resource at the specified path.

Method Details

read

@NotNull
@NotNull ReadResponse read(ConfigurationManager manager,
 ResourcePath path,
 @Nullable
 @Nullable String collection)

Reads a resource at the specified path.

Parameters:

manager - The configuration manager to use for reading the resource.

path - The path of the resource to read.

collection - The collection in which the resource resides, if applicable.

Returns:

A response containing the read resource data.