Dataproc Metastore v1alpha API - Class FederationName (2.0.0-alpha10)

public sealed class FederationName : IResourceName, IEquatable<FederationName>

Reference documentation and code samples for the Dataproc Metastore v1alpha API class FederationName.

Resource name for the Federation resource.

Inheritance

object > FederationName

Namespace

Google.Cloud.Metastore.V1Alpha

Assembly

Google.Cloud.Metastore.V1Alpha.dll

Constructors

FederationName(string, string, string)

public FederationName(string projectId, string locationId, string federationId)

Constructs a new instance of a FederationName class from the component parts of pattern projects/{project}/locations/{location}/federations/{federation}

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.

federationId string

The Federation ID. Must not be null or empty.

Properties

FederationId

public string FederationId { get; }

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

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

The FederationName.ResourceNameType of the contained resource name.

Property Value
Type Description
FederationNameResourceNameType

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

Formats the IDs into the string representation of this FederationName with pattern projects/{project}/locations/{location}/federations/{federation}.

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.

federationId string

The Federation ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this FederationName with pattern projects/{project}/locations/{location}/federations/{federation}.

FormatProjectLocationFederation(string, string, string)

public static string FormatProjectLocationFederation(string projectId, string locationId, string federationId)

Formats the IDs into the string representation of this FederationName with pattern projects/{project}/locations/{location}/federations/{federation}.

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.

federationId string

The Federation ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this FederationName with pattern projects/{project}/locations/{location}/federations/{federation}.

FromProjectLocationFederation(string, string, string)

public static FederationName FromProjectLocationFederation(string projectId, string locationId, string federationId)

Creates a FederationName with the pattern projects/{project}/locations/{location}/federations/{federation}.

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.

federationId string

The Federation ID. Must not be null or empty.

Returns
Type Description
FederationName

A new instance of FederationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FederationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FederationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
FederationName

A new instance of FederationName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static FederationName Parse(string federationName)

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

Parameter
Name Description
federationName string

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

Returns
Type Description
FederationName

The parsed FederationName if successful.

Remarks

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

  • projects/{project}/locations/{location}/federations/{federation}

Parse(string, bool)

public static FederationName Parse(string federationName, bool allowUnparsed)

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

Parameters
Name Description
federationName 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
FederationName

The parsed FederationName if successful.

Remarks

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

  • projects/{project}/locations/{location}/federations/{federation}
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 FederationName)

public static bool TryParse(string federationName, out FederationName result)

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

Parameters
Name Description
federationName string

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

result FederationName

When this method returns, the parsed FederationName, 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}/federations/{federation}

TryParse(string, bool, out FederationName)

public static bool TryParse(string federationName, bool allowUnparsed, out FederationName result)

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

Parameters
Name Description
federationName 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 FederationName

When this method returns, the parsed FederationName, 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}/federations/{federation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FederationName, FederationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FederationName

The first resource name to compare, or null.

b FederationName

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 !=(FederationName, FederationName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FederationName

The first resource name to compare, or null.

b FederationName

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.