public sealed class DocumentName : IResourceName, IEquatable<DocumentName>
Reference documentation and code samples for the Discovery Engine v1beta API class DocumentName.
Resource name for the Document
resource.
Namespace
Google.Cloud.DiscoveryEngine.V1BetaAssembly
Google.Cloud.DiscoveryEngine.V1Beta.dll
Constructors
DocumentName(string, string, string, string, string)
public DocumentName(string projectId, string locationId, string dataStoreId, string branchId, string documentId)
Constructs a new instance of a DocumentName class from the component parts of pattern
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
Properties
BranchId
public string BranchId { get; }
The Branch
ID. May be null
, depending on which resource name is contained by this instance.
Property Value | |
---|---|
Type | Description |
string |
CollectionId
public string CollectionId { get; }
The Collection
ID. May be null
, depending on which resource name is contained by this
instance.
Property Value | |
---|---|
Type | Description |
string |
DataStoreId
public string DataStoreId { get; }
The DataStore
ID. May be null
, depending on which resource name is contained by this instance.
Property Value | |
---|---|
Type | Description |
string |
DocumentId
public string DocumentId { get; }
The Document
ID. May be null
, depending on which resource name is contained by this instance.
Property Value | |
---|---|
Type | Description |
string |
IsKnownPattern
public bool IsKnownPattern { get; }
Whether this instance contains a resource name with a known pattern.
Property Value | |
---|---|
Type | Description |
bool |
LocationId
public string LocationId { get; }
The Location
ID. May be null
, depending on which resource name is contained by this instance.
Property Value | |
---|---|
Type | Description |
string |
ProjectId
public string ProjectId { get; }
The Project
ID. May be null
, depending on which resource name is contained by this instance.
Property Value | |
---|---|
Type | Description |
string |
Type
public DocumentName.ResourceNameType Type { get; }
The DocumentName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
DocumentNameResourceNameType |
UnparsedResource
public UnparsedResourceName UnparsedResource { get; }
The contained UnparsedResourceName. Only non-null
if this instance contains an
unparsed resource name.
Property Value | |
---|---|
Type | Description |
UnparsedResourceName |
Methods
Format(string, string, string, string, string)
public static string Format(string projectId, string locationId, string dataStoreId, string branchId, string documentId)
Formats the IDs into the string representation of this DocumentName with pattern
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this DocumentName with pattern
|
FormatProjectLocationCollectionDataStoreBranchDocument(string, string, string, string, string, string)
public static string FormatProjectLocationCollectionDataStoreBranchDocument(string projectId, string locationId, string collectionId, string dataStoreId, string branchId, string documentId)
Formats the IDs into the string representation of this DocumentName with pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this DocumentName with pattern
|
FormatProjectLocationDataStoreBranchDocument(string, string, string, string, string)
public static string FormatProjectLocationDataStoreBranchDocument(string projectId, string locationId, string dataStoreId, string branchId, string documentId)
Formats the IDs into the string representation of this DocumentName with pattern
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this DocumentName with pattern
|
FromProjectLocationCollectionDataStoreBranchDocument(string, string, string, string, string, string)
public static DocumentName FromProjectLocationCollectionDataStoreBranchDocument(string projectId, string locationId, string collectionId, string dataStoreId, string branchId, string documentId)
Creates a DocumentName with the pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
Returns | |
---|---|
Type | Description |
DocumentName |
A new instance of DocumentName constructed from the provided ids. |
FromProjectLocationDataStoreBranchDocument(string, string, string, string, string)
public static DocumentName FromProjectLocationDataStoreBranchDocument(string projectId, string locationId, string dataStoreId, string branchId, string documentId)
Creates a DocumentName with the pattern
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
Returns | |
---|---|
Type | Description |
DocumentName |
A new instance of DocumentName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static DocumentName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a DocumentName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
DocumentName |
A new instance of DocumentName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static DocumentName Parse(string documentName)
Parses the given resource name string into a new DocumentName instance.
Parameter | |
---|---|
Name | Description |
documentName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
DocumentName |
The parsed DocumentName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
Parse(string, bool)
public static DocumentName Parse(string documentName, bool allowUnparsed)
Parses the given resource name string into a new DocumentName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
documentName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
DocumentName |
The parsed DocumentName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
allowUnparsed
is true
.
ToString()
public override string ToString()
The string representation of the resource name.
Returns | |
---|---|
Type | Description |
string |
The string representation of the resource name. |
TryParse(string, out DocumentName)
public static bool TryParse(string documentName, out DocumentName result)
Tries to parse the given resource name string into a new DocumentName instance.
Parameters | |
---|---|
Name | Description |
documentName |
string The resource name in string form. Must not be |
result |
DocumentName When this method returns, the parsed DocumentName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
TryParse(string, bool, out DocumentName)
public static bool TryParse(string documentName, bool allowUnparsed, out DocumentName result)
Tries to parse the given resource name string into a new DocumentName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
documentName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
DocumentName When this method returns, the parsed DocumentName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
allowUnparsed
is true
.
Operators
operator ==(DocumentName, DocumentName)
public static bool operator ==(DocumentName a, DocumentName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
DocumentName The first resource name to compare, or null. |
b |
DocumentName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(DocumentName, DocumentName)
public static bool operator !=(DocumentName a, DocumentName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
DocumentName The first resource name to compare, or null. |
b |
DocumentName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |