Class TransferConfigName

public sealed class TransferConfigName : IResourceName, IEquatable<TransferConfigName>

Resource name for the TransferConfig resource.

Inheritance

Object > TransferConfigName

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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringtransferConfigId

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
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

TransferConfigId

public string TransferConfigId { get; }

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

Property Value
TypeDescription
String

Type

public TransferConfigName.ResourceNameType Type { get; }

The TransferConfigName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TransferConfigName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringtransferConfigId

The TransferConfig ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringtransferConfigId

The TransferConfig ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringtransferConfigId

The TransferConfig ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringlocationId

The Location ID. Must not be null or empty.

StringtransferConfigId

The TransferConfig ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
StringprojectId

The Project ID. Must not be null or empty.

StringtransferConfigId

The TransferConfig ID. Must not be null or empty.

Returns
TypeDescription
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
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TransferConfigName

A new instance of TransferConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static TransferConfigName Parse(string transferConfigName)

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

Parameter
TypeNameDescription
StringtransferConfigName

The resource name in string form. Must not be null.

Returns
TypeDescription
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, Boolean)

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
TypeNameDescription
StringtransferConfigName

The resource name in string form. Must not be null.

BooleanallowUnparsed

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
TypeNameDescription
StringtransferConfigName

The resource name in string form. Must not be null.

TransferConfigNameresult

When this method returns, the parsed TransferConfigName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
TypeNameDescription
StringtransferConfigName

The resource name in string form. Must not be null.

BooleanallowUnparsed

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.

TransferConfigNameresult

When this method returns, the parsed TransferConfigName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(TransferConfigName, TransferConfigName)

public static bool operator ==(TransferConfigName a, TransferConfigName b)
Parameters
TypeNameDescription
TransferConfigNamea
TransferConfigNameb
Returns
TypeDescription
Boolean

Inequality(TransferConfigName, TransferConfigName)

public static bool operator !=(TransferConfigName a, TransferConfigName b)
Parameters
TypeNameDescription
TransferConfigNamea
TransferConfigNameb
Returns
TypeDescription
Boolean