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

public sealed class SaasName : IResourceName, IEquatable<SaasName>

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

Resource name for the Saas resource.

Inheritance

object > SaasName

Namespace

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1

Assembly

Google.Cloud.SaasPlatform.SaasServiceMgmt.V1Beta1.dll

Constructors

SaasName(string, string, string)

public SaasName(string projectId, string locationId, string saasId)

Constructs a new instance of a SaasName class from the component parts of pattern projects/{project}/locations/{location}/saas/{saas}

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

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

SaasId

public string SaasId { get; }

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

Property Value
Type Description
string

Type

public SaasName.ResourceNameType Type { get; }

The SaasName.ResourceNameType of the contained resource name.

Property Value
Type Description
SaasNameResourceNameType

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

Formats the IDs into the string representation of this SaasName with pattern projects/{project}/locations/{location}/saas/{saas}.

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

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

The string representation of this SaasName with pattern projects/{project}/locations/{location}/saas/{saas}.

FormatProjectLocationSaas(string, string, string)

public static string FormatProjectLocationSaas(string projectId, string locationId, string saasId)

Formats the IDs into the string representation of this SaasName with pattern projects/{project}/locations/{location}/saas/{saas}.

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

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

The string representation of this SaasName with pattern projects/{project}/locations/{location}/saas/{saas}.

FromProjectLocationSaas(string, string, string)

public static SaasName FromProjectLocationSaas(string projectId, string locationId, string saasId)

Creates a SaasName with the pattern projects/{project}/locations/{location}/saas/{saas} .

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

The Saas ID. Must not be null or empty.
Returns
Type Description
SaasName

A new instance of SaasName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SaasName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SaasName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
saasName string

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

The parsed SaasName if successful.
Remarks

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

  • projects/{project}/locations/{location}/saas/{saas}

Parse(string, bool)

public static SaasName Parse(string saasName, bool allowUnparsed)

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

Parameters
Name Description
saasName 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
SaasName

The parsed SaasName if successful.
Remarks

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

  • projects/{project}/locations/{location}/saas/{saas}
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 SaasName)

public static bool TryParse(string saasName, out SaasName result)

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

Parameters
Name Description
saasName string

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

When this method returns, the parsed SaasName, 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}/saas/{saas}

TryParse(string, bool, out SaasName)

public static bool TryParse(string saasName, bool allowUnparsed, out SaasName result)

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

Parameters
Name Description
saasName 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 SaasName

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

Operators

operator ==(SaasName, SaasName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SaasName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SaasName

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

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.