Class DataExchangeName (1.0.0-beta01) 

public sealed class DataExchangeName : IResourceName, IEquatable<DataExchangeName>

Resource name for the DataExchange resource.

Inheritance

Object > DataExchangeName

Namespace

Google.Cloud.BigQuery.DataExchange.V1Beta1

Assembly

Google.Cloud.BigQuery.DataExchange.V1Beta1.dll

Constructors

DataExchangeName(String, String, String)

public DataExchangeName(string projectId, string locationId, string dataExchangeId)

Constructs a new instance of a DataExchangeName class from the component parts of pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}

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.
dataExchangeId String

The DataExchange ID. Must not be null or empty.

Properties

DataExchangeId

public string DataExchangeId { get; }

The DataExchange 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
Boolean

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 DataExchangeName.ResourceNameType Type { get; }

The DataExchangeName.ResourceNameType of the contained resource name.

Property Value
Type Description
DataExchangeName.ResourceNameType

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

Formats the IDs into the string representation of this DataExchangeName with pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}.

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.
dataExchangeId String

The DataExchange ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this DataExchangeName with pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}.

FormatProjectLocationDataExchange(String, String, String)

public static string FormatProjectLocationDataExchange(string projectId, string locationId, string dataExchangeId)

Formats the IDs into the string representation of this DataExchangeName with pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}.

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.
dataExchangeId String

The DataExchange ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this DataExchangeName with pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}.

FromProjectLocationDataExchange(String, String, String)

public static DataExchangeName FromProjectLocationDataExchange(string projectId, string locationId, string dataExchangeId)

Creates a DataExchangeName with the pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}.

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.
dataExchangeId String

The DataExchange ID. Must not be null or empty.
Returns
Type Description
DataExchangeName

A new instance of DataExchangeName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DataExchangeName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DataExchangeName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DataExchangeName

A new instance of DataExchangeName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static DataExchangeName Parse(string dataExchangeName)

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

Parameter
Name Description
dataExchangeName String

The resource name in string form. Must not be null.
Returns
Type Description
DataExchangeName

The parsed DataExchangeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataExchanges/{data_exchange}

Parse(String, Boolean)

public static DataExchangeName Parse(string dataExchangeName, bool allowUnparsed)

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

Parameters
Name Description
dataExchangeName String

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

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
DataExchangeName

The parsed DataExchangeName if successful.
Remarks

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

  • projects/{project}/locations/{location}/dataExchanges/{data_exchange}
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

TryParse(String, out DataExchangeName)

public static bool TryParse(string dataExchangeName, out DataExchangeName result)

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

Parameters
Name Description
dataExchangeName String

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

When this method returns, the parsed DataExchangeName, or null if parsing failed.
Returns
Type Description
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}/locations/{location}/dataExchanges/{data_exchange}

TryParse(String, Boolean, out DataExchangeName)

public static bool TryParse(string dataExchangeName, bool allowUnparsed, out DataExchangeName result)

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

Parameters
Name Description
dataExchangeName String

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

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 DataExchangeName

When this method returns, the parsed DataExchangeName, or null if parsing failed.
Returns
Type Description
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}/locations/{location}/dataExchanges/{data_exchange}
Or may be in any format if allowUnparsed is true.

Operators

Equality(DataExchangeName, DataExchangeName)

public static bool operator ==(DataExchangeName a, DataExchangeName b)
Parameters
Name Description
a DataExchangeName
b DataExchangeName
Returns
Type Description
Boolean

Inequality(DataExchangeName, DataExchangeName)

public static bool operator !=(DataExchangeName a, DataExchangeName b)
Parameters
Name Description
a DataExchangeName
b DataExchangeName
Returns
Type Description
Boolean