Cloud Dataplex v1 API - Class MetadataFeedName (3.13.0)

3.13.0 (latest) 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.0.0

public sealed class MetadataFeedName : IResourceName, IEquatable<MetadataFeedName>

Reference documentation and code samples for the Cloud Dataplex v1 API class MetadataFeedName.

Resource name for the MetadataFeed resource.

Inheritance

object > MetadataFeedName

Implements

IResourceName, IEquatableMetadataFeedName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

MetadataFeedName(string, string, string)

public MetadataFeedName(string projectId, string locationId, string metadataFeedId)

Constructs a new instance of a MetadataFeedName class from the component parts of pattern projects/{project}/locations/{location}/metadataFeeds/{metadata_feed}

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.
metadataFeedId	string The MetadataFeed 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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
string

MetadataFeedId

public string MetadataFeedId { get; }

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

The MetadataFeedName.ResourceNameType of the contained resource name.

Property Value
Type	Description
MetadataFeedNameResourceNameType

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

Formats the IDs into the string representation of this MetadataFeedName with pattern projects/{project}/locations/{location}/metadataFeeds/{metadata_feed}.

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.
metadataFeedId	string The MetadataFeed ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this MetadataFeedName with pattern projects/{project}/locations/{location}/metadataFeeds/{metadata_feed}.

FormatProjectLocationMetadataFeed(string, string, string)

public static string FormatProjectLocationMetadataFeed(string projectId, string locationId, string metadataFeedId)

Formats the IDs into the string representation of this MetadataFeedName with pattern projects/{project}/locations/{location}/metadataFeeds/{metadata_feed}.

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.
metadataFeedId	string The MetadataFeed ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this MetadataFeedName with pattern projects/{project}/locations/{location}/metadataFeeds/{metadata_feed}.

FromProjectLocationMetadataFeed(string, string, string)

public static MetadataFeedName FromProjectLocationMetadataFeed(string projectId, string locationId, string metadataFeedId)

Creates a MetadataFeedName with the pattern projects/{project}/locations/{location}/metadataFeeds/{metadata_feed}.

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.
metadataFeedId	string The MetadataFeed ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static MetadataFeedName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a MetadataFeedName containing an unparsed resource name.

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

Returns
Type	Description
MetadataFeedName	A new instance of MetadataFeedName 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 MetadataFeedName Parse(string metadataFeedName)

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

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

Returns
Type	Description
MetadataFeedName	The parsed MetadataFeedName if successful.

Remarks

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

• projects/{project}/locations/{location}/metadataFeeds/{metadata_feed}

Parse(string, bool)

public static MetadataFeedName Parse(string metadataFeedName, bool allowUnparsed)

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

Parameters
Name	Description
metadataFeedName	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
MetadataFeedName	The parsed MetadataFeedName if successful.

Remarks

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

• projects/{project}/locations/{location}/metadataFeeds/{metadata_feed}

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

public static bool TryParse(string metadataFeedName, out MetadataFeedName result)

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

Parameters
Name	Description
metadataFeedName	string The resource name in string form. Must not be null.
result	MetadataFeedName When this method returns, the parsed MetadataFeedName, 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}/metadataFeeds/{metadata_feed}

TryParse(string, bool, out MetadataFeedName)

public static bool TryParse(string metadataFeedName, bool allowUnparsed, out MetadataFeedName result)

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

Parameters
Name	Description
metadataFeedName	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	MetadataFeedName When this method returns, the parsed MetadataFeedName, 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}/metadataFeeds/{metadata_feed}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(MetadataFeedName, MetadataFeedName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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