Google BigQuery Data Transfer v1 API - Class TransferConfigName (4.8.0)

public sealed class TransferConfigName : IResourceName, IEquatable<TransferConfigName>

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

Resource name for the TransferConfig resource.

Inheritance

object > TransferConfigName

Implements

IResourceName, IEquatable TransferConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Constructors

TransferConfigName(string, string)

public TransferConfigName(string projectId, string transferConfigId)

Constructs a new instance of a TransferConfigName class from the component parts of pattern projects/{project}/transferConfigs/{transfer_config}

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

Properties

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`

TransferConfigId

public string TransferConfigId { get; }

The TransferConfig ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public TransferConfigName.ResourceNameType Type { get; }

The TransferConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TransferConfigNameResourceNameType`

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

Formats the IDs into the string representation of this TransferConfigName with pattern projects/{project}/transferConfigs/{transfer_config}.

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

Returns
Type	Description
`string`	The string representation of this TransferConfigName with pattern `projects/{project}/transferConfigs/{transfer_config}`.

FormatProjectLocationTransferConfig(string, string, string)

public static string FormatProjectLocationTransferConfig(string projectId, string locationId, string transferConfigId)

Formats the IDs into the string representation of this TransferConfigName with pattern projects/{project}/locations/{location}/transferConfigs/{transfer_config}.

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

Returns
Type	Description
`string`	The string representation of this TransferConfigName with pattern `projects/{project}/locations/{location}/transferConfigs/{transfer_config}`.

FormatProjectTransferConfig(string, string)

public static string FormatProjectTransferConfig(string projectId, string transferConfigId)

Formats the IDs into the string representation of this TransferConfigName with pattern projects/{project}/transferConfigs/{transfer_config}.

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

Returns
Type	Description
`string`	The string representation of this TransferConfigName with pattern `projects/{project}/transferConfigs/{transfer_config}`.

FromProjectLocationTransferConfig(string, string, string)

public static TransferConfigName FromProjectLocationTransferConfig(string projectId, string locationId, string transferConfigId)

Creates a TransferConfigName with the pattern projects/{project}/locations/{location}/transferConfigs/{transfer_config}.

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

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

FromProjectTransferConfig(string, string)

public static TransferConfigName FromProjectTransferConfig(string projectId, string transferConfigId)

Creates a TransferConfigName with the pattern projects/{project}/transferConfigs/{transfer_config}.

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

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

FromUnparsed(UnparsedResourceName)

public static TransferConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TransferConfigName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/transferConfigs/{transfer_config}
projects/{project}/locations/{location}/transferConfigs/{transfer_config}

Parse(string, bool)

public static TransferConfigName Parse(string transferConfigName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/transferConfigs/{transfer_config}
projects/{project}/locations/{location}/transferConfigs/{transfer_config}

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

public static bool TryParse(string transferConfigName, out TransferConfigName result)

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

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

TryParse(string, bool, out TransferConfigName)

public static bool TryParse(string transferConfigName, bool allowUnparsed, out TransferConfigName result)

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

Parameters
Name	Description
`transferConfigName`	`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`	`TransferConfigName` When this method returns, the parsed TransferConfigName, 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}/transferConfigs/{transfer_config}
projects/{project}/locations/{location}/transferConfigs/{transfer_config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TransferConfigName, TransferConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`TransferConfigName` The first resource name to compare, or null.
`b`	`TransferConfigName` 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 !=(TransferConfigName, TransferConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`TransferConfigName` The first resource name to compare, or null.
`b`	`TransferConfigName` 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.