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

Class DefaultResourceActions.Read

java.lang.Object

com.inductiveautomation.ignition.gateway.config.actions.DefaultResourceActions.Read

All Implemented Interfaces:

ResourceAction, ResourceAction.Read

Enclosing class:

DefaultResourceActions

public static final class DefaultResourceActions.Read
extends Object
implements ResourceAction.Read

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

Constructor Summary

Constructors

Constructor	Description
Read()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Read

public Read()

Method Details

read

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

Description copied from interface: ResourceAction.Read

Reads a resource at the specified path.

Specified by:

read in interface ResourceAction.Read

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.