Package p4.v1

Enum Class P4RuntimeOuterClass.SetForwardingPipelineConfigRequest.Action

java.lang.Object

java.lang.Enum<P4RuntimeOuterClass.SetForwardingPipelineConfigRequest.Action>

p4.v1.P4RuntimeOuterClass.SetForwardingPipelineConfigRequest.Action

All Implemented Interfaces:

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

Enclosing class:

P4RuntimeOuterClass.SetForwardingPipelineConfigRequest

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

Protobuf enum p4.v1.SetForwardingPipelineConfigRequest.Action

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	Description
static final int	COMMIT_VALUE	Realize the last saved, but not yet committed, config.
static final int	RECONCILE_AND_COMMIT_VALUE	Verify, save and realize the given config, while preserving the forwarding state in the target.
static final int	UNSPECIFIED_VALUE	UNSPECIFIED = 0;
static final int	VERIFY_AND_COMMIT_VALUE	Verify, save and realize the given config.
static final int	VERIFY_AND_SAVE_VALUE	Save the config if the target can realize it.
static final int	VERIFY_VALUE	Verify that the target can realize the given config.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNSPECIFIED

public static final P4RuntimeOuterClass.SetForwardingPipelineConfigRequest.Action UNSPECIFIED

UNSPECIFIED = 0;

VERIFY

public static final P4RuntimeOuterClass.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 P4RuntimeOuterClass.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 P4RuntimeOuterClass.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 P4RuntimeOuterClass.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 P4RuntimeOuterClass.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 P4RuntimeOuterClass.SetForwardingPipelineConfigRequest.Action UNRECOGNIZED

Field Details

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 Details

values

public static P4RuntimeOuterClass.SetForwardingPipelineConfigRequest.Action[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static P4RuntimeOuterClass.SetForwardingPipelineConfigRequest.Action valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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 P4RuntimeOuterClass.SetForwardingPipelineConfigRequest.Action valueOf(int value)

Deprecated.

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

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null

forNumber

public static P4RuntimeOuterClass.SetForwardingPipelineConfigRequest.Action forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<P4RuntimeOuterClass.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 com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

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

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

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

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

NullPointerException - if the argument is null