public sealed class DocumentProcessingConfigName : IResourceName, IEquatable<DocumentProcessingConfigName>
Reference documentation and code samples for the Discovery Engine v1 API class DocumentProcessingConfigName.
Resource name for the DocumentProcessingConfig
resource.
Namespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
DocumentProcessingConfigName(string, string, string)
public DocumentProcessingConfigName(string projectId, string locationId, string dataStoreId)
Constructs a new instance of a DocumentProcessingConfigName class from the component parts of
pattern projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
Properties
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 |
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 DocumentProcessingConfigName.ResourceNameType Type { get; }
The DocumentProcessingConfigName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
DocumentProcessingConfigNameResourceNameType |
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)
public static string Format(string projectId, string locationId, string dataStoreId)
Formats the IDs into the string representation of this DocumentProcessingConfigName with
pattern projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this DocumentProcessingConfigName with pattern
|
FormatProjectLocationCollectionDataStore(string, string, string, string)
public static string FormatProjectLocationCollectionDataStore(string projectId, string locationId, string collectionId, string dataStoreId)
Formats the IDs into the string representation of this DocumentProcessingConfigName with
pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this DocumentProcessingConfigName with pattern
|
FormatProjectLocationDataStore(string, string, string)
public static string FormatProjectLocationDataStore(string projectId, string locationId, string dataStoreId)
Formats the IDs into the string representation of this DocumentProcessingConfigName with
pattern projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this DocumentProcessingConfigName with pattern
|
FromProjectLocationCollectionDataStore(string, string, string, string)
public static DocumentProcessingConfigName FromProjectLocationCollectionDataStore(string projectId, string locationId, string collectionId, string dataStoreId)
Creates a DocumentProcessingConfigName with the pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
DocumentProcessingConfigName |
A new instance of DocumentProcessingConfigName constructed from the provided ids. |
FromProjectLocationDataStore(string, string, string)
public static DocumentProcessingConfigName FromProjectLocationDataStore(string projectId, string locationId, string dataStoreId)
Creates a DocumentProcessingConfigName with the pattern
projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
DocumentProcessingConfigName |
A new instance of DocumentProcessingConfigName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static DocumentProcessingConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a DocumentProcessingConfigName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
DocumentProcessingConfigName |
A new instance of DocumentProcessingConfigName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static DocumentProcessingConfigName Parse(string documentProcessingConfigName)
Parses the given resource name string into a new DocumentProcessingConfigName instance.
Parameter | |
---|---|
Name | Description |
documentProcessingConfigName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
DocumentProcessingConfigName |
The parsed DocumentProcessingConfigName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig
Parse(string, bool)
public static DocumentProcessingConfigName Parse(string documentProcessingConfigName, bool allowUnparsed)
Parses the given resource name string into a new DocumentProcessingConfigName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
documentProcessingConfigName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
DocumentProcessingConfigName |
The parsed DocumentProcessingConfigName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig
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 DocumentProcessingConfigName)
public static bool TryParse(string documentProcessingConfigName, out DocumentProcessingConfigName result)
Tries to parse the given resource name string into a new DocumentProcessingConfigName instance.
Parameters | |
---|---|
Name | Description |
documentProcessingConfigName |
string The resource name in string form. Must not be |
result |
DocumentProcessingConfigName When this method returns, the parsed DocumentProcessingConfigName, 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}/documentProcessingConfig
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig
TryParse(string, bool, out DocumentProcessingConfigName)
public static bool TryParse(string documentProcessingConfigName, bool allowUnparsed, out DocumentProcessingConfigName result)
Tries to parse the given resource name string into a new DocumentProcessingConfigName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
documentProcessingConfigName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
DocumentProcessingConfigName When this method returns, the parsed DocumentProcessingConfigName, 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}/documentProcessingConfig
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig
allowUnparsed
is true
.
Operators
operator ==(DocumentProcessingConfigName, DocumentProcessingConfigName)
public static bool operator ==(DocumentProcessingConfigName a, DocumentProcessingConfigName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
DocumentProcessingConfigName The first resource name to compare, or null. |
b |
DocumentProcessingConfigName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(DocumentProcessingConfigName, DocumentProcessingConfigName)
public static bool operator !=(DocumentProcessingConfigName a, DocumentProcessingConfigName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
DocumentProcessingConfigName The first resource name to compare, or null. |
b |
DocumentProcessingConfigName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |