Cloud Dataplex v1 API - Class ContentName (2.2.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class ContentName : IResourceName, IEquatable<ContentName>

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

Resource name for the Content resource.

Inheritance

Object > ContentName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

ContentName(String, String, String, String)

public ContentName(string projectId, string locationId, string lakeId, string contentId)

Constructs a new instance of a ContentName class from the component parts of pattern projects/{project}/locations/{location}/lakes/{lake}/content/{content}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

lakeIdString

The Lake ID. Must not be null or empty.

contentIdString

The Content ID. Must not be null or empty.

Properties

ContentId

public string ContentId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LakeId

public string LakeId { get; }

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

Property Value
TypeDescription
String

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public ContentName.ResourceNameType Type { get; }

The ContentName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ContentName.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, String, String)

public static string Format(string projectId, string locationId, string lakeId, string contentId)

Formats the IDs into the string representation of this ContentName with pattern projects/{project}/locations/{location}/lakes/{lake}/content/{content}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

lakeIdString

The Lake ID. Must not be null or empty.

contentIdString

The Content ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ContentName with pattern projects/{project}/locations/{location}/lakes/{lake}/content/{content}.

FormatProjectLocationLakeContent(String, String, String, String)

public static string FormatProjectLocationLakeContent(string projectId, string locationId, string lakeId, string contentId)

Formats the IDs into the string representation of this ContentName with pattern projects/{project}/locations/{location}/lakes/{lake}/content/{content}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

lakeIdString

The Lake ID. Must not be null or empty.

contentIdString

The Content ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ContentName with pattern projects/{project}/locations/{location}/lakes/{lake}/content/{content}.

FromProjectLocationLakeContent(String, String, String, String)

public static ContentName FromProjectLocationLakeContent(string projectId, string locationId, string lakeId, string contentId)

Creates a ContentName with the pattern projects/{project}/locations/{location}/lakes/{lake}/content/{content}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

lakeIdString

The Lake ID. Must not be null or empty.

contentIdString

The Content ID. Must not be null or empty.

Returns
TypeDescription
ContentName

A new instance of ContentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ContentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ContentName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ContentName

A new instance of ContentName 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 ContentName Parse(string contentName)

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

Parameter
NameDescription
contentNameString

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

Returns
TypeDescription
ContentName

The parsed ContentName if successful.

Remarks

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

  • projects/{project}/locations/{location}/lakes/{lake}/content/{content}

Parse(String, Boolean)

public static ContentName Parse(string contentName, bool allowUnparsed)

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

Parameters
NameDescription
contentNameString

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

allowUnparsedBoolean

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
ContentName

The parsed ContentName if successful.

Remarks

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

  • projects/{project}/locations/{location}/lakes/{lake}/content/{content}
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 ContentName)

public static bool TryParse(string contentName, out ContentName result)

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

Parameters
NameDescription
contentNameString

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

resultContentName

When this method returns, the parsed ContentName, 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}/locations/{location}/lakes/{lake}/content/{content}

TryParse(String, Boolean, out ContentName)

public static bool TryParse(string contentName, bool allowUnparsed, out ContentName result)

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

Parameters
NameDescription
contentNameString

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

allowUnparsedBoolean

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.

resultContentName

When this method returns, the parsed ContentName, 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}/locations/{location}/lakes/{lake}/content/{content}
Or may be in any format if allowUnparsed is true.

Operators

Equality(ContentName, ContentName)

public static bool operator ==(ContentName a, ContentName b)
Parameters
NameDescription
aContentName
bContentName
Returns
TypeDescription
Boolean

Inequality(ContentName, ContentName)

public static bool operator !=(ContentName a, ContentName b)
Parameters
NameDescription
aContentName
bContentName
Returns
TypeDescription
Boolean