Google BigQuery Data Transfer v1 API - Class DataSourceName (4.4.0)

public sealed class DataSourceName : IResourceName, IEquatable<DataSourceName>

Reference documentation and code samples for the Google BigQuery Data Transfer v1 API class DataSourceName.

Resource name for the DataSource resource.

Inheritance

object > DataSourceName

Implements

IResourceName, IEquatable DataSourceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Constructors

DataSourceName(string, string)

public DataSourceName(string projectId, string dataSourceId)

Constructs a new instance of a DataSourceName class from the component parts of pattern projects/{project}/dataSources/{data_source}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`dataSourceId`	`string` The `DataSource` ID. Must not be `null` or empty.

Properties

DataSourceId

public string DataSourceId { get; }

The DataSource 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 DataSourceName.ResourceNameType Type { get; }

The DataSourceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`DataSourceNameResourceNameType`

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)

public static string Format(string projectId, string dataSourceId)

Formats the IDs into the string representation of this DataSourceName with pattern projects/{project}/dataSources/{data_source}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`dataSourceId`	`string` The `DataSource` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this DataSourceName with pattern `projects/{project}/dataSources/{data_source}`.

FormatProjectDataSource(string, string)

public static string FormatProjectDataSource(string projectId, string dataSourceId)

Formats the IDs into the string representation of this DataSourceName with pattern projects/{project}/dataSources/{data_source}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`dataSourceId`	`string` The `DataSource` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this DataSourceName with pattern `projects/{project}/dataSources/{data_source}`.

FormatProjectLocationDataSource(string, string, string)

public static string FormatProjectLocationDataSource(string projectId, string locationId, string dataSourceId)

Formats the IDs into the string representation of this DataSourceName with pattern projects/{project}/locations/{location}/dataSources/{data_source}.

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.
`dataSourceId`	`string` The `DataSource` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this DataSourceName with pattern `projects/{project}/locations/{location}/dataSources/{data_source}`.

FromProjectDataSource(string, string)

public static DataSourceName FromProjectDataSource(string projectId, string dataSourceId)

Creates a DataSourceName with the pattern projects/{project}/dataSources/{data_source}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`dataSourceId`	`string` The `DataSource` ID. Must not be `null` or empty.

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

FromProjectLocationDataSource(string, string, string)

public static DataSourceName FromProjectLocationDataSource(string projectId, string locationId, string dataSourceId)

Creates a DataSourceName with the pattern projects/{project}/locations/{location}/dataSources/{data_source}.

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.
`dataSourceId`	`string` The `DataSource` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static DataSourceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataSourceName containing an unparsed resource name.

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

Returns
Type	Description
`DataSourceName`	A new instance of DataSourceName 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 DataSourceName Parse(string dataSourceName)

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

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

Returns
Type	Description
`DataSourceName`	The parsed DataSourceName if successful.

Remarks

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

projects/{project}/dataSources/{data_source}
projects/{project}/locations/{location}/dataSources/{data_source}

Parse(string, bool)

public static DataSourceName Parse(string dataSourceName, bool allowUnparsed)

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

Parameters
Name	Description
`dataSourceName`	`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
`DataSourceName`	The parsed DataSourceName if successful.

Remarks

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

projects/{project}/dataSources/{data_source}
projects/{project}/locations/{location}/dataSources/{data_source}

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

public static bool TryParse(string dataSourceName, out DataSourceName result)

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

Parameters
Name	Description
`dataSourceName`	`string` The resource name in string form. Must not be `null`.
`result`	`DataSourceName` When this method returns, the parsed DataSourceName, 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}/dataSources/{data_source}
projects/{project}/locations/{location}/dataSources/{data_source}

TryParse(string, bool, out DataSourceName)

public static bool TryParse(string dataSourceName, bool allowUnparsed, out DataSourceName result)

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

Parameters
Name	Description
`dataSourceName`	`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`	`DataSourceName` When this method returns, the parsed DataSourceName, 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}/dataSources/{data_source}
projects/{project}/locations/{location}/dataSources/{data_source}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(DataSourceName, DataSourceName)

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

Parameters
Name	Description
`a`	`DataSourceName`
`b`	`DataSourceName`

Returns
Type	Description
`bool`

operator !=(DataSourceName, DataSourceName)

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

Parameters
Name	Description
`a`	`DataSourceName`
`b`	`DataSourceName`

Returns
Type	Description
`bool`