Class DocumentName (0.33.0)

public class DocumentName implements ResourceName

Inheritance

Object > DocumentName

Implements

com.google.api.resourcenames.ResourceName

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
NameDescription
projectString
locationString
dataStoreString
branchString
documentString
Returns
TypeDescription
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
NameDescription
projectString
locationString
collectionString
dataStoreString
branchString
documentString
Returns
TypeDescription
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
NameDescription
projectString
locationString
dataStoreString
branchString
documentString
Returns
TypeDescription
String

isParsableFrom(String formattedString)

public static boolean isParsableFrom(String formattedString)
Parameter
NameDescription
formattedStringString
Returns
TypeDescription
boolean

newBuilder()

public static DocumentName.Builder newBuilder()
Returns
TypeDescription
DocumentName.Builder

newProjectLocationCollectionDataStoreBranchDocumentBuilder()

public static DocumentName.ProjectLocationCollectionDataStoreBranchDocumentBuilder newProjectLocationCollectionDataStoreBranchDocumentBuilder()
Returns
TypeDescription
DocumentName.ProjectLocationCollectionDataStoreBranchDocumentBuilder

newProjectLocationDataStoreBranchDocumentBuilder()

public static DocumentName.Builder newProjectLocationDataStoreBranchDocumentBuilder()
Returns
TypeDescription
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
NameDescription
projectString
locationString
dataStoreString
branchString
documentString
Returns
TypeDescription
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
NameDescription
projectString
locationString
collectionString
dataStoreString
branchString
documentString
Returns
TypeDescription
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
NameDescription
projectString
locationString
dataStoreString
branchString
documentString
Returns
TypeDescription
DocumentName

parse(String formattedString)

public static DocumentName parse(String formattedString)
Parameter
NameDescription
formattedStringString
Returns
TypeDescription
DocumentName

parseList(List<String> formattedStrings)

public static List<DocumentName> parseList(List<String> formattedStrings)
Parameter
NameDescription
formattedStringsList<String>
Returns
TypeDescription
List<DocumentName>

toStringList(List<DocumentName> values)

public static List<String> toStringList(List<DocumentName> values)
Parameter
NameDescription
valuesList<DocumentName>
Returns
TypeDescription
List<String>

Constructors

DocumentName() (deprecated)

protected DocumentName()

Methods

equals(Object o)

public boolean equals(Object o)
Parameter
NameDescription
oObject
Returns
TypeDescription
boolean
Overrides

getBranch()

public String getBranch()
Returns
TypeDescription
String

getCollection()

public String getCollection()
Returns
TypeDescription
String

getDataStore()

public String getDataStore()
Returns
TypeDescription
String

getDocument()

public String getDocument()
Returns
TypeDescription
String

getFieldValue(String fieldName)

public String getFieldValue(String fieldName)
Parameter
NameDescription
fieldNameString
Returns
TypeDescription
String

getFieldValuesMap()

public Map<String,String> getFieldValuesMap()
Returns
TypeDescription
Map<String,String>

getLocation()

public String getLocation()
Returns
TypeDescription
String

getProject()

public String getProject()
Returns
TypeDescription
String

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

toBuilder()

public DocumentName.Builder toBuilder()
Returns
TypeDescription
DocumentName.Builder

toString()

public String toString()
Returns
TypeDescription
String
Overrides