org.opendaylight.p4plugin.p4runtime.proto

Enum SetForwardingPipelineConfigRequest.Action

java.lang.Object

java.lang.Enum<SetForwardingPipelineConfigRequest.Action>

org.opendaylight.p4plugin.p4runtime.proto.SetForwardingPipelineConfigRequest.Action

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SetForwardingPipelineConfigRequest.Action>

Enclosing class:

SetForwardingPipelineConfigRequest

public static enum SetForwardingPipelineConfigRequest.Action
extends Enum<SetForwardingPipelineConfigRequest.Action>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum p4.v1.SetForwardingPipelineConfigRequest.Action

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMMIT Realize the last saved, but not yet committed, config.
RECONCILE_AND_COMMIT Verify, save and realize the given config, while preserving the forwarding state in the target.
UNRECOGNIZED
UNSPECIFIED UNSPECIFIED = 0;
VERIFY Verify that the target can realize the given config.
VERIFY_AND_COMMIT Verify, save and realize the given config.
VERIFY_AND_SAVE Save the config if the target can realize it.

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMIT_VALUE Realize the last saved, but not yet committed, config.
static int	RECONCILE_AND_COMMIT_VALUE Verify, save and realize the given config, while preserving the forwarding state in the target.
static int	UNSPECIFIED_VALUE UNSPECIFIED = 0;
static int	VERIFY_AND_COMMIT_VALUE Verify, save and realize the given config.
static int	VERIFY_AND_SAVE_VALUE Save the config if the target can realize it.
static int	VERIFY_VALUE Verify that the target can realize the given config.

Method Summary

Modifier and Type	Method and Description
static SetForwardingPipelineConfigRequest.Action	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<SetForwardingPipelineConfigRequest.Action>	internalGetValueMap()
static SetForwardingPipelineConfigRequest.Action	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static SetForwardingPipelineConfigRequest.Action	valueOf(int value) Deprecated. Use forNumber(int) instead.
static SetForwardingPipelineConfigRequest.Action	valueOf(String name) Returns the enum constant of this type with the specified name.
static SetForwardingPipelineConfigRequest.Action[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNSPECIFIED

public static final SetForwardingPipelineConfigRequest.Action UNSPECIFIED

UNSPECIFIED = 0;

VERIFY

public static final SetForwardingPipelineConfigRequest.Action VERIFY

 Verify that the target can realize the given config. Do not modify the
 forwarding state in the target. Returns error if config is not provided
 of if the provided config cannot be realized.
 

VERIFY = 1;

VERIFY_AND_SAVE

public static final SetForwardingPipelineConfigRequest.Action VERIFY_AND_SAVE

 Save the config if the target can realize it. Do not modify the
 forwarding state in the target. Any subsequent read/write requests must
 refer to fields in the new config. Returns error if config is not
 provided of if the provided config cannot be realized.
 

VERIFY_AND_SAVE = 2;

VERIFY_AND_COMMIT

public static final SetForwardingPipelineConfigRequest.Action VERIFY_AND_COMMIT

 Verify, save and realize the given config. Clear the forwarding state
 in the target. Returns error if config is not provided of if the
 provided config cannot be realized.
 

VERIFY_AND_COMMIT = 3;

COMMIT

public static final SetForwardingPipelineConfigRequest.Action COMMIT

 Realize the last saved, but not yet committed, config. Update the
 forwarding state in the target by replaying the write requests since the
 last config was saved. Config should not be provided for this action
 type. Returns an error if no saved config is found or if a config is
 provided with this message.
 

COMMIT = 4;

RECONCILE_AND_COMMIT

public static final SetForwardingPipelineConfigRequest.Action RECONCILE_AND_COMMIT

 Verify, save and realize the given config, while preserving the
 forwarding state in the target. This is an advanced use case to enable
 changes to the P4 forwarding pipeline configuration with minimal traffic
 loss. P4Runtime does not impose any constraints on the duration of the
 traffic loss. The support for this option is not expected to be uniform
 across all P4Runtime targets. A target that does not support this option
 may return an UNIMPLEMENTED error. For targets that support this option,
 an INVALID_ARGUMENT error is returned if no config is provided, or if
 the existing forwarding state cannot be preserved for the given config
 by the target.
 

RECONCILE_AND_COMMIT = 5;

UNRECOGNIZED

public static final SetForwardingPipelineConfigRequest.Action UNRECOGNIZED

Field Detail

UNSPECIFIED_VALUE

public static final int UNSPECIFIED_VALUE

UNSPECIFIED = 0;

See Also:

Constant Field Values

VERIFY_VALUE

public static final int VERIFY_VALUE

 Verify that the target can realize the given config. Do not modify the
 forwarding state in the target. Returns error if config is not provided
 of if the provided config cannot be realized.
 

VERIFY = 1;

See Also:

Constant Field Values

VERIFY_AND_SAVE_VALUE

public static final int VERIFY_AND_SAVE_VALUE

 Save the config if the target can realize it. Do not modify the
 forwarding state in the target. Any subsequent read/write requests must
 refer to fields in the new config. Returns error if config is not
 provided of if the provided config cannot be realized.
 

VERIFY_AND_SAVE = 2;

See Also:

Constant Field Values

VERIFY_AND_COMMIT_VALUE

public static final int VERIFY_AND_COMMIT_VALUE

 Verify, save and realize the given config. Clear the forwarding state
 in the target. Returns error if config is not provided of if the
 provided config cannot be realized.
 

VERIFY_AND_COMMIT = 3;

See Also:

Constant Field Values

COMMIT_VALUE

public static final int COMMIT_VALUE

 Realize the last saved, but not yet committed, config. Update the
 forwarding state in the target by replaying the write requests since the
 last config was saved. Config should not be provided for this action
 type. Returns an error if no saved config is found or if a config is
 provided with this message.
 

COMMIT = 4;

See Also:

Constant Field Values

RECONCILE_AND_COMMIT_VALUE

public static final int RECONCILE_AND_COMMIT_VALUE

 Verify, save and realize the given config, while preserving the
 forwarding state in the target. This is an advanced use case to enable
 changes to the P4 forwarding pipeline configuration with minimal traffic
 loss. P4Runtime does not impose any constraints on the duration of the
 traffic loss. The support for this option is not expected to be uniform
 across all P4Runtime targets. A target that does not support this option
 may return an UNIMPLEMENTED error. For targets that support this option,
 an INVALID_ARGUMENT error is returned if no config is provided, or if
 the existing forwarding state cannot be preserved for the given config
 by the target.
 

RECONCILE_AND_COMMIT = 5;

See Also:

Constant Field Values

Method Detail

values

public static SetForwardingPipelineConfigRequest.Action[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SetForwardingPipelineConfigRequest.Action c : SetForwardingPipelineConfigRequest.Action.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SetForwardingPipelineConfigRequest.Action valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static SetForwardingPipelineConfigRequest.Action valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static SetForwardingPipelineConfigRequest.Action forNumber(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<SetForwardingPipelineConfigRequest.Action> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static SetForwardingPipelineConfigRequest.Action valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)