public sealed class ChunkName : IResourceName, IEquatable<ChunkName>
Reference documentation and code samples for the Discovery Engine v1beta API class ChunkName.
Resource name for the Chunk
resource.
Namespace
Google.Cloud.DiscoveryEngine.V1BetaAssembly
Google.Cloud.DiscoveryEngine.V1Beta.dll
Constructors
ChunkName(string, string, string, string, string, string)
public ChunkName(string projectId, string locationId, string dataStoreId, string branchId, string documentId, string chunkId)
Constructs a new instance of a ChunkName class from the component parts of pattern
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
chunkId |
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 |
ChunkId
public string ChunkId { get; }
The Chunk
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 ChunkName.ResourceNameType Type { get; }
The ChunkName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
ChunkNameResourceNameType |
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, string)
public static string Format(string projectId, string locationId, string dataStoreId, string branchId, string documentId, string chunkId)
Formats the IDs into the string representation of this ChunkName with pattern
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
chunkId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ChunkName with pattern
|
FormatProjectLocationCollectionDataStoreBranchDocumentChunk(string, string, string, string, string, string, string)
public static string FormatProjectLocationCollectionDataStoreBranchDocumentChunk(string projectId, string locationId, string collectionId, string dataStoreId, string branchId, string documentId, string chunkId)
Formats the IDs into the string representation of this ChunkName with pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
chunkId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ChunkName with pattern
|
FormatProjectLocationDataStoreBranchDocumentChunk(string, string, string, string, string, string)
public static string FormatProjectLocationDataStoreBranchDocumentChunk(string projectId, string locationId, string dataStoreId, string branchId, string documentId, string chunkId)
Formats the IDs into the string representation of this ChunkName with pattern
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
chunkId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ChunkName with pattern
|
FromProjectLocationCollectionDataStoreBranchDocumentChunk(string, string, string, string, string, string, string)
public static ChunkName FromProjectLocationCollectionDataStoreBranchDocumentChunk(string projectId, string locationId, string collectionId, string dataStoreId, string branchId, string documentId, string chunkId)
Creates a ChunkName with the pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
chunkId |
string The |
Returns | |
---|---|
Type | Description |
ChunkName |
A new instance of ChunkName constructed from the provided ids. |
FromProjectLocationDataStoreBranchDocumentChunk(string, string, string, string, string, string)
public static ChunkName FromProjectLocationDataStoreBranchDocumentChunk(string projectId, string locationId, string dataStoreId, string branchId, string documentId, string chunkId)
Creates a ChunkName with the pattern
projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
branchId |
string The |
documentId |
string The |
chunkId |
string The |
Returns | |
---|---|
Type | Description |
ChunkName |
A new instance of ChunkName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static ChunkName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a ChunkName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
ChunkName |
A new instance of ChunkName containing the provided |
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static ChunkName Parse(string chunkName)
Parses the given resource name string into a new ChunkName instance.
Parameter | |
---|---|
Name | Description |
chunkName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
ChunkName |
The parsed ChunkName 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}/chunks/{chunk}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
Parse(string, bool)
public static ChunkName Parse(string chunkName, bool allowUnparsed)
Parses the given resource name string into a new ChunkName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
chunkName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
ChunkName |
The parsed ChunkName 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}/chunks/{chunk}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
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 ChunkName)
public static bool TryParse(string chunkName, out ChunkName result)
Tries to parse the given resource name string into a new ChunkName instance.
Parameters | |
---|---|
Name | Description |
chunkName |
string The resource name in string form. Must not be |
result |
ChunkName When this method returns, the parsed ChunkName, 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}/chunks/{chunk}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
TryParse(string, bool, out ChunkName)
public static bool TryParse(string chunkName, bool allowUnparsed, out ChunkName result)
Tries to parse the given resource name string into a new ChunkName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
chunkName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
ChunkName When this method returns, the parsed ChunkName, 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}/chunks/{chunk}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}
allowUnparsed
is true
.
Operators
operator ==(ChunkName, ChunkName)
public static bool operator ==(ChunkName a, ChunkName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
ChunkName The first resource name to compare, or null. |
b |
ChunkName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(ChunkName, ChunkName)
public static bool operator !=(ChunkName a, ChunkName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
ChunkName The first resource name to compare, or null. |
b |
ChunkName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |