Artifact Registry v1 API - Class GoModuleName (2.10.0) 

public sealed class GoModuleName : IResourceName, IEquatable<GoModuleName>

Reference documentation and code samples for the Artifact Registry v1 API class GoModuleName.

Resource name for the GoModule resource.

Inheritance

object > GoModuleName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

GoModuleName(string, string, string, string)

public GoModuleName(string projectId, string locationId, string repositoryId, string goModuleId)

Constructs a new instance of a GoModuleName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/goModules/{go_module}

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

The Repository ID. Must not be null or empty.
goModuleId string

The GoModule ID. Must not be null or empty.

Properties

GoModuleId

public string GoModuleId { get; }

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

RepositoryId

public string RepositoryId { get; }

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

Property Value
Type Description
string

Type

public GoModuleName.ResourceNameType Type { get; }

The GoModuleName.ResourceNameType of the contained resource name.

Property Value
Type Description
GoModuleNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string repositoryId, string goModuleId)

Formats the IDs into the string representation of this GoModuleName with pattern projects/{project}/locations/{location}/repositories/{repository}/goModules/{go_module}.

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

The Repository ID. Must not be null or empty.
goModuleId string

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

The string representation of this GoModuleName with pattern projects/{project}/locations/{location}/repositories/{repository}/goModules/{go_module}.

FormatProjectLocationRepositoryGoModule(string, string, string, string)

public static string FormatProjectLocationRepositoryGoModule(string projectId, string locationId, string repositoryId, string goModuleId)

Formats the IDs into the string representation of this GoModuleName with pattern projects/{project}/locations/{location}/repositories/{repository}/goModules/{go_module}.

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

The Repository ID. Must not be null or empty.
goModuleId string

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

The string representation of this GoModuleName with pattern projects/{project}/locations/{location}/repositories/{repository}/goModules/{go_module}.

FromProjectLocationRepositoryGoModule(string, string, string, string)

public static GoModuleName FromProjectLocationRepositoryGoModule(string projectId, string locationId, string repositoryId, string goModuleId)

Creates a GoModuleName with the pattern projects/{project}/locations/{location}/repositories/{repository}/goModules/{go_module}.

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

The Repository ID. Must not be null or empty.
goModuleId string

The GoModule ID. Must not be null or empty.
Returns
Type Description
GoModuleName

A new instance of GoModuleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GoModuleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GoModuleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
goModuleName string

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

The parsed GoModuleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/goModules/{go_module}

Parse(string, bool)

public static GoModuleName Parse(string goModuleName, bool allowUnparsed)

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

Parameters
Name Description
goModuleName 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
GoModuleName

The parsed GoModuleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/goModules/{go_module}
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 GoModuleName)

public static bool TryParse(string goModuleName, out GoModuleName result)

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

Parameters
Name Description
goModuleName string

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

When this method returns, the parsed GoModuleName, 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}/repositories/{repository}/goModules/{go_module}

TryParse(string, bool, out GoModuleName)

public static bool TryParse(string goModuleName, bool allowUnparsed, out GoModuleName result)

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

Parameters
Name Description
goModuleName 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 GoModuleName

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

Operators

operator ==(GoModuleName, GoModuleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a GoModuleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a GoModuleName

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

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.