Enum CompanionAds.DisplayRequirement
java.lang.Object
java.lang.Enum<CompanionAds.DisplayRequirement>
com.google.cloud.video.stitcher.v1.CompanionAds.DisplayRequirement
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<CompanionAds.DisplayRequirement>
- Enclosing class:
- CompanionAds
public static enum CompanionAds.DisplayRequirement
extends Enum<CompanionAds.DisplayRequirement>
implements com.google.protobuf.ProtocolMessageEnum
Indicates how many of the companions should be displayed with the ad.Protobuf enum
google.cloud.video.stitcher.v1.CompanionAds.DisplayRequirement-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAll companions are required to be displayed.At least one of companions needs to be displayed.Required companions are not specified.All companions are optional for display. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intAll companions are required to be displayed.static final intAt least one of companions needs to be displayed.static final intRequired companions are not specified.static final intAll companions are optional for display. -
Method Summary
Modifier and TypeMethodDescriptionforNumber(int value) static com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<CompanionAds.DisplayRequirement>valueOf(int value) Deprecated.valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.Returns the enum constant of this type with the specified name.static CompanionAds.DisplayRequirement[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
DISPLAY_REQUIREMENT_UNSPECIFIED
Required companions are not specified. The default is ALL.
DISPLAY_REQUIREMENT_UNSPECIFIED = 0; -
ALL
All companions are required to be displayed.
ALL = 1; -
ANY
At least one of companions needs to be displayed.
ANY = 2; -
NONE
All companions are optional for display.
NONE = 3; -
UNRECOGNIZED
-
-
Field Details
-
DISPLAY_REQUIREMENT_UNSPECIFIED_VALUE
public static final int DISPLAY_REQUIREMENT_UNSPECIFIED_VALUERequired companions are not specified. The default is ALL.
DISPLAY_REQUIREMENT_UNSPECIFIED = 0;- See Also:
-
ALL_VALUE
public static final int ALL_VALUEAll companions are required to be displayed.
ALL = 1;- See Also:
-
ANY_VALUE
public static final int ANY_VALUEAt least one of companions needs to be displayed.
ANY = 2;- See Also:
-
NONE_VALUE
public static final int NONE_VALUEAll companions are optional for display.
NONE = 3;- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.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:
value- 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 nameNullPointerException- if the argument is null
-
forNumber
- 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<CompanionAds.DisplayRequirement> internalGetValueMap() -
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static CompanionAds.DisplayRequirement valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) 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:
desc- 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 nameNullPointerException- if the argument is null
-