Analytics Hub v1 API - Class ListingName (1.1.0)

public sealed class ListingName : IResourceName, IEquatable<ListingName>

Reference documentation and code samples for the Analytics Hub v1 API class ListingName.

Resource name for the Listing resource.

Inheritance

object > ListingName

Implements

IResourceName, IEquatable ListingName

Inherited Members

object.GetType()

Namespace

Google.Cloud.BigQuery.AnalyticsHub.V1

Assembly

Google.Cloud.BigQuery.AnalyticsHub.V1.dll

Constructors

ListingName(string, string, string, string)

public ListingName(string projectId, string locationId, string dataExchangeId, string listingId)

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

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.
`listingId`	`string` The `Listing` 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
`bool`

ListingId

public string ListingId { get; }

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

Property Value
Type	Description
`string`

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

The ListingName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ListingNameResourceNameType`

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, string)

public static string Format(string projectId, string locationId, string dataExchangeId, string listingId)

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

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

Returns
Type	Description
`string`	The string representation of this ListingName with pattern `projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}`.

FormatProjectLocationDataExchangeListing(string, string, string, string)

public static string FormatProjectLocationDataExchangeListing(string projectId, string locationId, string dataExchangeId, string listingId)

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

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

Returns
Type	Description
`string`	The string representation of this ListingName with pattern `projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}`.

FromProjectLocationDataExchangeListing(string, string, string, string)

public static ListingName FromProjectLocationDataExchangeListing(string projectId, string locationId, string dataExchangeId, string listingId)

Creates a ListingName with the pattern projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}.

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

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

FromUnparsed(UnparsedResourceName)

public static ListingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ListingName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}

Parse(string, bool)

public static ListingName Parse(string listingName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listings/{listing}

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

public static bool TryParse(string listingName, out ListingName result)

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

Parameters
Name	Description
`listingName`	`string` The resource name in string form. Must not be `null`.
`result`	`ListingName` When this method returns, the parsed ListingName, 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}/dataExchanges/{data_exchange}/listings/{listing}

TryParse(string, bool, out ListingName)

public static bool TryParse(string listingName, bool allowUnparsed, out ListingName result)

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

Parameters
Name	Description
`listingName`	`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`	`ListingName` When this method returns, the parsed ListingName, 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}/dataExchanges/{data_exchange}/listings/{listing}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ListingName, ListingName)

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

Parameters
Name	Description
`a`	`ListingName`
`b`	`ListingName`

Returns
Type	Description
`bool`

operator !=(ListingName, ListingName)

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

Parameters
Name	Description
`a`	`ListingName`
`b`	`ListingName`

Returns
Type	Description
`bool`