SaaS Runtime v1beta1 API - Class RolloutKindName (1.0.0-beta01) 

public sealed class RolloutKindName : IResourceName, IEquatable<RolloutKindName>

Reference documentation and code samples for the SaaS Runtime v1beta1 API class RolloutKindName.

Resource name for the RolloutKind resource.

Inheritance

object > RolloutKindName

Namespace

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1

Assembly

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll

Constructors

RolloutKindName(string, string, string)

public RolloutKindName(string projectId, string locationId, string rolloutKindId)

Constructs a new instance of a RolloutKindName class from the component parts of pattern projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}

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

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

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

RolloutKindId

public string RolloutKindId { get; }

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

Property Value
Type Description
string

Type

public RolloutKindName.ResourceNameType Type { get; }

The RolloutKindName.ResourceNameType of the contained resource name.

Property Value
Type Description
RolloutKindNameResourceNameType

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

Formats the IDs into the string representation of this RolloutKindName with pattern projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}.

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

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

The string representation of this RolloutKindName with pattern projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}.

FormatProjectLocationRolloutKind(string, string, string)

public static string FormatProjectLocationRolloutKind(string projectId, string locationId, string rolloutKindId)

Formats the IDs into the string representation of this RolloutKindName with pattern projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}.

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

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

The string representation of this RolloutKindName with pattern projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}.

FromProjectLocationRolloutKind(string, string, string)

public static RolloutKindName FromProjectLocationRolloutKind(string projectId, string locationId, string rolloutKindId)

Creates a RolloutKindName with the pattern projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}.

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

The RolloutKind ID. Must not be null or empty.
Returns
Type Description
RolloutKindName

A new instance of RolloutKindName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RolloutKindName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RolloutKindName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
rolloutKindName string

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

The parsed RolloutKindName if successful.
Remarks

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

  • projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}

Parse(string, bool)

public static RolloutKindName Parse(string rolloutKindName, bool allowUnparsed)

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

Parameters
Name Description
rolloutKindName 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
RolloutKindName

The parsed RolloutKindName if successful.
Remarks

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

  • projects/{project}/locations/{location}/rolloutKinds/{rollout_kind_id}
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 RolloutKindName)

public static bool TryParse(string rolloutKindName, out RolloutKindName result)

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

Parameters
Name Description
rolloutKindName string

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

When this method returns, the parsed RolloutKindName, 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}/rolloutKinds/{rollout_kind_id}

TryParse(string, bool, out RolloutKindName)

public static bool TryParse(string rolloutKindName, bool allowUnparsed, out RolloutKindName result)

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

Parameters
Name Description
rolloutKindName 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 RolloutKindName

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

Operators

operator ==(RolloutKindName, RolloutKindName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a RolloutKindName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a RolloutKindName

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

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.