API hub v1 API - Class StyleGuideName (1.0.0-beta02) 

public sealed class StyleGuideName : IResourceName, IEquatable<StyleGuideName>

Reference documentation and code samples for the API hub v1 API class StyleGuideName.

Resource name for the StyleGuide resource.

Inheritance

object > StyleGuideName

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

StyleGuideName(string, string, string)

public StyleGuideName(string projectId, string locationId, string pluginId)

Constructs a new instance of a StyleGuideName class from the component parts of pattern projects/{project}/locations/{location}/plugins/{plugin}/styleGuide

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

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

PluginId

public string PluginId { get; }

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

The StyleGuideName.ResourceNameType of the contained resource name.

Property Value
Type Description
StyleGuideNameResourceNameType

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

Formats the IDs into the string representation of this StyleGuideName with pattern projects/{project}/locations/{location}/plugins/{plugin}/styleGuide.

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

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

The string representation of this StyleGuideName with pattern projects/{project}/locations/{location}/plugins/{plugin}/styleGuide.

FormatProjectLocationPlugin(string, string, string)

public static string FormatProjectLocationPlugin(string projectId, string locationId, string pluginId)

Formats the IDs into the string representation of this StyleGuideName with pattern projects/{project}/locations/{location}/plugins/{plugin}/styleGuide.

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

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

The string representation of this StyleGuideName with pattern projects/{project}/locations/{location}/plugins/{plugin}/styleGuide.

FromProjectLocationPlugin(string, string, string)

public static StyleGuideName FromProjectLocationPlugin(string projectId, string locationId, string pluginId)

Creates a StyleGuideName with the pattern projects/{project}/locations/{location}/plugins/{plugin}/styleGuide.

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

The Plugin ID. Must not be null or empty.
Returns
Type Description
StyleGuideName

A new instance of StyleGuideName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static StyleGuideName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a StyleGuideName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
styleGuideName string

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

The parsed StyleGuideName if successful.
Remarks

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

  • projects/{project}/locations/{location}/plugins/{plugin}/styleGuide

Parse(string, bool)

public static StyleGuideName Parse(string styleGuideName, bool allowUnparsed)

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

Parameters
Name Description
styleGuideName 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
StyleGuideName

The parsed StyleGuideName if successful.
Remarks

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

  • projects/{project}/locations/{location}/plugins/{plugin}/styleGuide
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 StyleGuideName)

public static bool TryParse(string styleGuideName, out StyleGuideName result)

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

Parameters
Name Description
styleGuideName string

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

When this method returns, the parsed StyleGuideName, 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}/plugins/{plugin}/styleGuide

TryParse(string, bool, out StyleGuideName)

public static bool TryParse(string styleGuideName, bool allowUnparsed, out StyleGuideName result)

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

Parameters
Name Description
styleGuideName 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 StyleGuideName

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

Operators

operator ==(StyleGuideName, StyleGuideName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a StyleGuideName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a StyleGuideName

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

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.