Class PartitionName (2.1.0)

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

Resource name for the Partition resource.

Inheritance

Object > PartitionName

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

PartitionName(String, String, String, String, String, String)

public PartitionName(string projectId, string locationId, string lakeId, string zoneId, string entityId, string partitionId)

Constructs a new instance of a PartitionName class from the component parts of pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition}

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.

zoneIdString

The Zone ID. Must not be null or empty.

entityIdString

The Entity ID. Must not be null or empty.

partitionIdString

The Partition ID. Must not be null or empty.

Properties

EntityId

public string EntityId { get; }

The Entity 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

PartitionId

public string PartitionId { get; }

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

The PartitionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
PartitionName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

ZoneId

public string ZoneId { get; }

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

Property Value
TypeDescription
String

Methods

Format(String, String, String, String, String, String)

public static string Format(string projectId, string locationId, string lakeId, string zoneId, string entityId, string partitionId)

Formats the IDs into the string representation of this PartitionName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition} .

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.

zoneIdString

The Zone ID. Must not be null or empty.

entityIdString

The Entity ID. Must not be null or empty.

partitionIdString

The Partition ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this PartitionName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition} .

FormatProjectLocationLakeZoneEntityPartition(String, String, String, String, String, String)

public static string FormatProjectLocationLakeZoneEntityPartition(string projectId, string locationId, string lakeId, string zoneId, string entityId, string partitionId)

Formats the IDs into the string representation of this PartitionName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition} .

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.

zoneIdString

The Zone ID. Must not be null or empty.

entityIdString

The Entity ID. Must not be null or empty.

partitionIdString

The Partition ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this PartitionName with pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition} .

FromProjectLocationLakeZoneEntityPartition(String, String, String, String, String, String)

public static PartitionName FromProjectLocationLakeZoneEntityPartition(string projectId, string locationId, string lakeId, string zoneId, string entityId, string partitionId)

Creates a PartitionName with the pattern projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition} .

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.

zoneIdString

The Zone ID. Must not be null or empty.

entityIdString

The Entity ID. Must not be null or empty.

partitionIdString

The Partition ID. Must not be null or empty.

Returns
TypeDescription
PartitionName

A new instance of PartitionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static PartitionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PartitionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
PartitionName

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

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

Parameter
NameDescription
partitionNameString

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

Returns
TypeDescription
PartitionName

The parsed PartitionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition}

Parse(String, Boolean)

public static PartitionName Parse(string partitionName, bool allowUnparsed)

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

Parameters
NameDescription
partitionNameString

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
PartitionName

The parsed PartitionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity}/partitions/{partition}
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 PartitionName)

public static bool TryParse(string partitionName, out PartitionName result)

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

Parameters
NameDescription
partitionNameString

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

resultPartitionName

When this method returns, the parsed PartitionName, 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}/zones/{zone}/entities/{entity}/partitions/{partition}

TryParse(String, Boolean, out PartitionName)

public static bool TryParse(string partitionName, bool allowUnparsed, out PartitionName result)

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

Parameters
NameDescription
partitionNameString

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.

resultPartitionName

When this method returns, the parsed PartitionName, 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}/zones/{zone}/entities/{entity}/partitions/{partition}
Or may be in any format if allowUnparsed is true.

Operators

Equality(PartitionName, PartitionName)

public static bool operator ==(PartitionName a, PartitionName b)
Parameters
NameDescription
aPartitionName
bPartitionName
Returns
TypeDescription
Boolean

Inequality(PartitionName, PartitionName)

public static bool operator !=(PartitionName a, PartitionName b)
Parameters
NameDescription
aPartitionName
bPartitionName
Returns
TypeDescription
Boolean