Class DocumentName (0.38.0)

Version 0.38.0

• 0.50.0 (latest)
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public class DocumentName implements ResourceName

Inheritance

Object > DocumentName

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 location, String dataStore, String branch, String document)

public static String format(String project, String location, String dataStore, String branch, String document)

Parameters
Name	Description
project	String
location	String
dataStore	String
branch	String
document	String

Returns
Type	Description
String

formatProjectLocationCollectionDataStoreBranchDocumentName(String project, String location, String collection, String dataStore, String branch, String document)

public static String formatProjectLocationCollectionDataStoreBranchDocumentName(String project, String location, String collection, String dataStore, String branch, String document)

Parameters
Name	Description
project	String
location	String
collection	String
dataStore	String
branch	String
document	String

Returns
Type	Description
String

formatProjectLocationDataStoreBranchDocumentName(String project, String location, String dataStore, String branch, String document)

public static String formatProjectLocationDataStoreBranchDocumentName(String project, String location, String dataStore, String branch, String document)

Parameters
Name	Description
project	String
location	String
dataStore	String
branch	String
document	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 DocumentName.Builder newBuilder()

Returns
Type	Description
DocumentName.Builder

newProjectLocationCollectionDataStoreBranchDocumentBuilder()

public static DocumentName.ProjectLocationCollectionDataStoreBranchDocumentBuilder newProjectLocationCollectionDataStoreBranchDocumentBuilder()

Returns
Type	Description
DocumentName.ProjectLocationCollectionDataStoreBranchDocumentBuilder

newProjectLocationDataStoreBranchDocumentBuilder()

public static DocumentName.Builder newProjectLocationDataStoreBranchDocumentBuilder()

Returns
Type	Description
DocumentName.Builder

of(String project, String location, String dataStore, String branch, String document)

public static DocumentName of(String project, String location, String dataStore, String branch, String document)

Parameters
Name	Description
project	String
location	String
dataStore	String
branch	String
document	String

Returns
Type	Description
DocumentName

ofProjectLocationCollectionDataStoreBranchDocumentName(String project, String location, String collection, String dataStore, String branch, String document)

public static DocumentName ofProjectLocationCollectionDataStoreBranchDocumentName(String project, String location, String collection, String dataStore, String branch, String document)

Parameters
Name	Description
project	String
location	String
collection	String
dataStore	String
branch	String
document	String

Returns
Type	Description
DocumentName

ofProjectLocationDataStoreBranchDocumentName(String project, String location, String dataStore, String branch, String document)

public static DocumentName ofProjectLocationDataStoreBranchDocumentName(String project, String location, String dataStore, String branch, String document)

Parameters
Name	Description
project	String
location	String
dataStore	String
branch	String
document	String

Returns
Type	Description
DocumentName

parse(String formattedString)

public static DocumentName parse(String formattedString)

Parameter
Name	Description
formattedString	String

Returns
Type	Description
DocumentName

parseList(List<String> formattedStrings)

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

Parameter
Name	Description
formattedStrings	List<String>

Returns
Type	Description
List<DocumentName>

toStringList(List<DocumentName> values)

public static List<String> toStringList(List<DocumentName> values)

Parameter
Name	Description
values	List<DocumentName>

Returns
Type	Description
List<String>

Constructors

DocumentName() (deprecated)

protected DocumentName()

Methods

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
o	Object

Returns
Type	Description
boolean

Overrides

Object.equals(Object)

getBranch()

public String getBranch()

Returns
Type	Description
String

getCollection()

public String getCollection()

Returns
Type	Description
String

getDataStore()

public String getDataStore()

Returns
Type	Description
String

getDocument()

public String getDocument()

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>

getLocation()

public String getLocation()

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 DocumentName.Builder toBuilder()

Returns
Type	Description
DocumentName.Builder

toString()

public String toString()

Returns
Type	Description
String

Overrides

Object.toString()