GKE Hub v1 API - Class FleetName (2.8.0) 

public sealed class FleetName : IResourceName, IEquatable<FleetName>

Reference documentation and code samples for the GKE Hub v1 API class FleetName.

Resource name for the Fleet resource.

Inheritance

object > FleetName

Namespace

Google.Cloud.GkeHub.V1

Assembly

Google.Cloud.GkeHub.V1.dll

Constructors

FleetName(string, string, string)

public FleetName(string projectId, string locationId, string fleetId)

Constructs a new instance of a FleetName class from the component parts of pattern projects/{project}/locations/{location}/fleets/{fleet}

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.
fleetId string

The Fleet ID. Must not be null or empty.

Properties

FleetId

public string FleetId { get; }

The Fleet ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public FleetName.ResourceNameType Type { get; }

The FleetName.ResourceNameType of the contained resource name.

Property Value
Type Description
FleetNameResourceNameType

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

Formats the IDs into the string representation of this FleetName with pattern projects/{project}/locations/{location}/fleets/{fleet}.

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.
fleetId string

The Fleet ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this FleetName with pattern projects/{project}/locations/{location}/fleets/{fleet}.

FormatOrganizationLocationFleet(string, string, string)

public static string FormatOrganizationLocationFleet(string organizationId, string locationId, string fleetId)

Formats the IDs into the string representation of this FleetName with pattern organizations/{organization}/locations/{location}/fleets/{fleet}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
fleetId string

The Fleet ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this FleetName with pattern organizations/{organization}/locations/{location}/fleets/{fleet}.

FormatProjectLocationFleet(string, string, string)

public static string FormatProjectLocationFleet(string projectId, string locationId, string fleetId)

Formats the IDs into the string representation of this FleetName with pattern projects/{project}/locations/{location}/fleets/{fleet}.

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.
fleetId string

The Fleet ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this FleetName with pattern projects/{project}/locations/{location}/fleets/{fleet}.

FromOrganizationLocationFleet(string, string, string)

public static FleetName FromOrganizationLocationFleet(string organizationId, string locationId, string fleetId)

Creates a FleetName with the pattern organizations/{organization}/locations/{location}/fleets/{fleet}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
fleetId string

The Fleet ID. Must not be null or empty.
Returns
Type Description
FleetName

A new instance of FleetName constructed from the provided ids.

FromProjectLocationFleet(string, string, string)

public static FleetName FromProjectLocationFleet(string projectId, string locationId, string fleetId)

Creates a FleetName with the pattern projects/{project}/locations/{location}/fleets/{fleet} .

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.
fleetId string

The Fleet ID. Must not be null or empty.
Returns
Type Description
FleetName

A new instance of FleetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FleetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FleetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
FleetName

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

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

Parameter
Name Description
fleetName string

The resource name in string form. Must not be null.
Returns
Type Description
FleetName

The parsed FleetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/fleets/{fleet}
  • organizations/{organization}/locations/{location}/fleets/{fleet}

Parse(string, bool)

public static FleetName Parse(string fleetName, bool allowUnparsed)

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

Parameters
Name Description
fleetName 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
FleetName

The parsed FleetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/fleets/{fleet}
  • organizations/{organization}/locations/{location}/fleets/{fleet}
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 FleetName)

public static bool TryParse(string fleetName, out FleetName result)

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

Parameters
Name Description
fleetName string

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

When this method returns, the parsed FleetName, 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}/fleets/{fleet}
  • organizations/{organization}/locations/{location}/fleets/{fleet}

TryParse(string, bool, out FleetName)

public static bool TryParse(string fleetName, bool allowUnparsed, out FleetName result)

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

Parameters
Name Description
fleetName 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 FleetName

When this method returns, the parsed FleetName, 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}/fleets/{fleet}
  • organizations/{organization}/locations/{location}/fleets/{fleet}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FleetName, FleetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FleetName

The first resource name to compare, or null.
b FleetName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FleetName

The first resource name to compare, or null.
b FleetName

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.