Discovery Engine v1 API - Class DataConnectorName (1.17.0)

1.17.0 (latest) 1.16.0 1.15.0 1.14.0 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0-beta06

public sealed class DataConnectorName : IResourceName, IEquatable<DataConnectorName>

Reference documentation and code samples for the Discovery Engine v1 API class DataConnectorName.

Resource name for the DataConnector resource.

Inheritance

object > DataConnectorName

Implements

IResourceName, IEquatableDataConnectorName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

DataConnectorName(string, string, string)

public DataConnectorName(string projectId, string locationId, string collectionId)

Constructs a new instance of a DataConnectorName class from the component parts of pattern projects/{project}/locations/{location}/collections/{collection}/dataConnector

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
collectionId	string The Collection ID. Must not be null or empty.

Properties

CollectionId

public string CollectionId { get; }

The Collection ID. Will not be null, unless this instance contains an unparsed resource name.

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
string

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
string

Type

public DataConnectorName.ResourceNameType Type { get; }

The DataConnectorName.ResourceNameType of the contained resource name.

Property Value
Type	Description
DataConnectorNameResourceNameType

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 collectionId)

Formats the IDs into the string representation of this DataConnectorName with pattern projects/{project}/locations/{location}/collections/{collection}/dataConnector.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
collectionId	string The Collection ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DataConnectorName with pattern projects/{project}/locations/{location}/collections/{collection}/dataConnector.

FormatProjectLocationCollection(string, string, string)

public static string FormatProjectLocationCollection(string projectId, string locationId, string collectionId)

Formats the IDs into the string representation of this DataConnectorName with pattern projects/{project}/locations/{location}/collections/{collection}/dataConnector.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
collectionId	string The Collection ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this DataConnectorName with pattern projects/{project}/locations/{location}/collections/{collection}/dataConnector.

FromProjectLocationCollection(string, string, string)

public static DataConnectorName FromProjectLocationCollection(string projectId, string locationId, string collectionId)

Creates a DataConnectorName with the pattern projects/{project}/locations/{location}/collections/{collection}/dataConnector.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
locationId	string The Location ID. Must not be null or empty.
collectionId	string The Collection ID. Must not be null or empty.

Returns
Type	Description
DataConnectorName	A new instance of DataConnectorName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataConnectorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataConnectorName containing an unparsed resource name.

Parameter
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
DataConnectorName	A new instance of DataConnectorName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static DataConnectorName Parse(string dataConnectorName)

Parses the given resource name string into a new DataConnectorName instance.

Parameter
Name	Description
dataConnectorName	string The resource name in string form. Must not be null.

Returns
Type	Description
DataConnectorName	The parsed DataConnectorName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/collections/{collection}/dataConnector

Parse(string, bool)

public static DataConnectorName Parse(string dataConnectorName, bool allowUnparsed)

Parses the given resource name string into a new DataConnectorName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
dataConnectorName	string The resource name in string form. Must not be null.
allowUnparsed	bool If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type	Description
DataConnectorName	The parsed DataConnectorName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/collections/{collection}/dataConnector

Or may be in any format if 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.

Overrides

object.ToString()

TryParse(string, out DataConnectorName)

public static bool TryParse(string dataConnectorName, out DataConnectorName result)

Tries to parse the given resource name string into a new DataConnectorName instance.

Parameters
Name	Description
dataConnectorName	string The resource name in string form. Must not be null.
result	DataConnectorName When this method returns, the parsed DataConnectorName, or null if parsing failed.

Returns
Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/collections/{collection}/dataConnector

TryParse(string, bool, out DataConnectorName)

public static bool TryParse(string dataConnectorName, bool allowUnparsed, out DataConnectorName result)

Tries to parse the given resource name string into a new DataConnectorName instance; optionally allowing an unparseable resource name.

Parameters
Name	Description
dataConnectorName	string The resource name in string form. Must not be null.
allowUnparsed	bool If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.
result	DataConnectorName When this method returns, the parsed DataConnectorName, or null if parsing failed.

Returns
Type	Description
bool	true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

• projects/{project}/locations/{location}/collections/{collection}/dataConnector

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataConnectorName, DataConnectorName)

public static bool operator ==(DataConnectorName a, DataConnectorName b)

Determines whether two specified resource names have the same value.

Parameters
Name	Description
a	DataConnectorName The first resource name to compare, or null.
b	DataConnectorName The second resource name to compare, or null.

Returns
Type	Description
bool	true if the value of a is the same as the value of b; otherwise, false.

operator !=(DataConnectorName, DataConnectorName)

public static bool operator !=(DataConnectorName a, DataConnectorName b)

Determines whether two specified resource names have different values.

Parameters
Name	Description
a	DataConnectorName The first resource name to compare, or null.
b	DataConnectorName The second resource name to compare, or null.

Returns
Type	Description
bool	true if the value of a is different from the value of b; otherwise, false.