Class DocumentName (4.17.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 knowledgeBase, String document)

public static String format(String project, String knowledgeBase, String document)

Parameters

Name	Description
`project`	`String`
`knowledgeBase`	`String`
`document`	`String`

Returns

Type	Description
`String`

formatProjectKnowledgeBaseDocumentName(String project, String knowledgeBase, String document)

public static String formatProjectKnowledgeBaseDocumentName(String project, String knowledgeBase, String document)

Parameters

Name	Description
`project`	`String`
`knowledgeBase`	`String`
`document`	`String`

Returns

Type	Description
`String`

formatProjectLocationKnowledgeBaseDocumentName(String project, String location, String knowledgeBase, String document)

public static String formatProjectLocationKnowledgeBaseDocumentName(String project, String location, String knowledgeBase, String document)

Parameters

Name	Description
`project`	`String`
`location`	`String`
`knowledgeBase`	`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`

newProjectKnowledgeBaseDocumentBuilder()

public static DocumentName.Builder newProjectKnowledgeBaseDocumentBuilder()

Returns

Type	Description
`DocumentName.Builder`

newProjectLocationKnowledgeBaseDocumentBuilder()

public static DocumentName.ProjectLocationKnowledgeBaseDocumentBuilder newProjectLocationKnowledgeBaseDocumentBuilder()

Returns

Type	Description
`DocumentName.ProjectLocationKnowledgeBaseDocumentBuilder`

of(String project, String knowledgeBase, String document)

public static DocumentName of(String project, String knowledgeBase, String document)

Parameters

Name	Description
`project`	`String`
`knowledgeBase`	`String`
`document`	`String`

Returns

Type	Description
`DocumentName`

ofProjectKnowledgeBaseDocumentName(String project, String knowledgeBase, String document)

public static DocumentName ofProjectKnowledgeBaseDocumentName(String project, String knowledgeBase, String document)

Parameters

Name	Description
`project`	`String`
`knowledgeBase`	`String`
`document`	`String`

Returns

Type	Description
`DocumentName`

ofProjectLocationKnowledgeBaseDocumentName(String project, String location, String knowledgeBase, String document)

public static DocumentName ofProjectLocationKnowledgeBaseDocumentName(String project, String location, String knowledgeBase, String document)

Parameters

Name	Description
`project`	`String`
`location`	`String`
`knowledgeBase`	`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()

protected DocumentName()

Methods

equals(Object o)

public boolean equals(Object o)

Parameter

Name	Description
`o`	`Object`

Returns

Type	Description
`boolean`

Overrides

Object.equals(Object)

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>`

getKnowledgeBase()

public String getKnowledgeBase()

Returns

Type	Description
`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()