Class IndexName (3.45.0)

3.45.0 (latest) 3.44.0 3.43.1 3.41.0 3.38.0 3.37.0 3.36.0 3.35.1 3.33.4 3.32.2 3.31.9 3.30.11 3.28.0 3.27.2 3.26.5 3.25.1 3.24.3 3.22.0 3.21.4 3.20.0 3.17.0 3.16.3 3.15.7 3.14.4 3.13.2 3.12.1 3.11.0 3.10.0 3.9.6 3.8.2 3.7.10 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.1.0 3.0.21

public class IndexName implements ResourceName

Inheritance

java.lang.Object > IndexName

Implements

com.google.api.resourcenames.ResourceName

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

format(String project, String database, String collection, String index)

public static String format(String project, String database, String collection, String index)

Parameters
Name	Description
project	String
database	String
collection	String
index	String

Returns
Type	Description
String

isParsableFrom(String formattedString)

public static boolean isParsableFrom(String formattedString)

Parameter
Name	Description
formattedString	String

Returns
Type	Description
boolean

newBuilder()

public static IndexName.Builder newBuilder()

Returns
Type	Description
IndexName.Builder

of(String project, String database, String collection, String index)

public static IndexName of(String project, String database, String collection, String index)

Parameters
Name	Description
project	String
database	String
collection	String
index	String

Returns
Type	Description
IndexName

parse(String formattedString)

public static @Nullable IndexName parse(String formattedString)

Parameter
Name	Description
formattedString	String

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.firestore.admin.v1.IndexName

parseList(List<String> formattedStrings)

public static List<IndexName> parseList(List<String> formattedStrings)

Parameter
Name	Description
formattedStrings	List<String>

Returns
Type	Description
List<IndexName>

toStringList(List<@Nullable IndexName> values)

public static List<String> toStringList(List<@Nullable IndexName> values)

Parameter
Name	Description
values	List<@org.jspecify.annotations.Nullable com.google.firestore.admin.v1.IndexName>

Returns
Type	Description
List<String>

Constructors

IndexName() (deprecated)

protected IndexName()

Methods

equals(@Nullable Object o)

public boolean equals(@Nullable Object o)

Parameter
Name	Description
o	@org.jspecify.annotations.Nullable java.lang.Object

Returns
Type	Description
boolean

Overrides

Object.equals(Object)

getCollection()

public String getCollection()

Returns
Type	Description
String

getDatabase()

public String getDatabase()

Returns
Type	Description
String

getFieldValue(String fieldName)

public String getFieldValue(String fieldName)

Parameter
Name	Description
fieldName	String

Returns
Type	Description
String

getFieldValuesMap()

public Map<String,String> getFieldValuesMap()

Returns
Type	Description
Map<String,String>

getIndex()

public String getIndex()

Returns
Type	Description
String

getProject()

public String getProject()

Returns
Type	Description
String

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

Object.hashCode()

toBuilder()

public IndexName.Builder toBuilder()

Returns
Type	Description
IndexName.Builder

toString()

public String toString()

Returns
Type	Description
String

Overrides

Object.toString()