Package com.google.cloud.contentwarehouse.v1

Enum SearchDocumentsRequest.TotalResultSize

java.lang.Object

java.lang.Enum<SearchDocumentsRequest.TotalResultSize>

com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchDocumentsRequest.TotalResultSize>

Enclosing class:

SearchDocumentsRequest

public static enum SearchDocumentsRequest.TotalResultSize
extends Enum<SearchDocumentsRequest.TotalResultSize>
implements com.google.protobuf.ProtocolMessageEnum

 The total number of matching documents.
 

Protobuf enum google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTUAL_SIZE	It may adversely impact performance.
ESTIMATED_SIZE	Estimate total number.
TOTAL_RESULT_SIZE_UNSPECIFIED	Total number calculation will be skipped.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static int	ACTUAL_SIZE_VALUE	It may adversely impact performance.
static int	ESTIMATED_SIZE_VALUE	Estimate total number.
static int	TOTAL_RESULT_SIZE_UNSPECIFIED_VALUE	Total number calculation will be skipped.

Method Summary

Modifier and Type	Method	Description
static SearchDocumentsRequest.TotalResultSize	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<SearchDocumentsRequest.TotalResultSize>	internalGetValueMap()
static SearchDocumentsRequest.TotalResultSize	valueOf(int value)	Deprecated.
static SearchDocumentsRequest.TotalResultSize	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this type with the specified name.
static SearchDocumentsRequest.TotalResultSize	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SearchDocumentsRequest.TotalResultSize[]	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

TOTAL_RESULT_SIZE_UNSPECIFIED

public static final SearchDocumentsRequest.TotalResultSize TOTAL_RESULT_SIZE_UNSPECIFIED

 Total number calculation will be skipped.
 

TOTAL_RESULT_SIZE_UNSPECIFIED = 0;

ESTIMATED_SIZE

public static final SearchDocumentsRequest.TotalResultSize ESTIMATED_SIZE

 Estimate total number. The total result size will be accurated up to
 10,000. This option will add cost and latency to your request.
 

ESTIMATED_SIZE = 1;

ACTUAL_SIZE

public static final SearchDocumentsRequest.TotalResultSize ACTUAL_SIZE

 It may adversely impact performance. The limit is 1000,000.
 

ACTUAL_SIZE = 2;

UNRECOGNIZED

public static final SearchDocumentsRequest.TotalResultSize UNRECOGNIZED

Field Detail

TOTAL_RESULT_SIZE_UNSPECIFIED_VALUE

public static final int TOTAL_RESULT_SIZE_UNSPECIFIED_VALUE

 Total number calculation will be skipped.
 

TOTAL_RESULT_SIZE_UNSPECIFIED = 0;

See Also:

Constant Field Values

ESTIMATED_SIZE_VALUE

public static final int ESTIMATED_SIZE_VALUE

 Estimate total number. The total result size will be accurated up to
 10,000. This option will add cost and latency to your request.
 

ESTIMATED_SIZE = 1;

See Also:

Constant Field Values

ACTUAL_SIZE_VALUE

public static final int ACTUAL_SIZE_VALUE

 It may adversely impact performance. The limit is 1000,000.
 

ACTUAL_SIZE = 2;

See Also:

Constant Field Values

Method Detail

values

public static SearchDocumentsRequest.TotalResultSize[] 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 (SearchDocumentsRequest.TotalResultSize c : SearchDocumentsRequest.TotalResultSize.values())
    System.out.println(c);

Returns:

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

valueOf

public static SearchDocumentsRequest.TotalResultSize 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 SearchDocumentsRequest.TotalResultSize valueOf(int value)

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 name

NullPointerException - if the argument is null

forNumber

public static SearchDocumentsRequest.TotalResultSize 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<SearchDocumentsRequest.TotalResultSize> 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 SearchDocumentsRequest.TotalResultSize 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 name

NullPointerException - if the argument is null