Class DocumentName (0.48.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
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

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

toBuilder()

public DocumentName.Builder toBuilder()
Returns
Type Description
DocumentName.Builder

toString()

public String toString()
Returns
Type Description
String
Overrides