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

Interface ResourceAction.Copy

All Superinterfaces:

ResourceAction

All Known Implementing Classes:

DefaultResourceActions.Copy

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.Copy
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 StructuralModificationResponse	copy(ConfigurationManager manager, ResourceType resourceType, @Nullable String fromName, @Nullable String toName, @Nullable String fromCollection, @Nullable String toCollection, ImmutableBytes signature, ResourceAction.ContextObject contextObject)	Copies a resource from one location to another.

Method Details

copy

@NotNull
@NotNull StructuralModificationResponse copy(ConfigurationManager manager,
 ResourceType resourceType,
 @Nullable
 @Nullable String fromName,
 @Nullable
 @Nullable String toName,
 @Nullable
 @Nullable String fromCollection,
 @Nullable
 @Nullable String toCollection,
 ImmutableBytes signature,
 ResourceAction.ContextObject contextObject)

Copies a resource from one location to another.

Parameters:

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

resourceType - The type of the resource to copy.

fromName - The name of the resource to copy from.

toName - The name of the resource to copy to.

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

toCollection - The collection in which the destination resource will reside, if applicable.

signature - The signature of the resource being copied.

contextObject - The context object to associated with the change.

Returns:

A response indicating the result of the copy operation.