Class FileName (2.0.0) 

public sealed class FileName : IResourceName, IEquatable<FileName>

Resource name for the File resource.

Inheritance

Object > FileName

Namespace

Google.Cloud.ArtifactRegistry.V1

Assembly

Google.Cloud.ArtifactRegistry.V1.dll

Constructors

FileName(String, String, String, String)

public FileName(string projectId, string locationId, string repositoryId, string fileId)

Constructs a new instance of a FileName class from the component parts of pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}

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.
fileId String

The File ID. Must not be null or empty.

Properties

FileId

public string FileId { get; }

The File 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
Boolean

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 FileName.ResourceNameType Type { get; }

The FileName.ResourceNameType of the contained resource name.

Property Value
Type Description
FileName.ResourceNameType

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

Formats the IDs into the string representation of this FileName with pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}.

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.
fileId String

The File ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this FileName with pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}.

FormatProjectLocationRepositoryFile(String, String, String, String)

public static string FormatProjectLocationRepositoryFile(string projectId, string locationId, string repositoryId, string fileId)

Formats the IDs into the string representation of this FileName with pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}.

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.
fileId String

The File ID. Must not be null or empty.
Returns
Type Description
String

The string representation of this FileName with pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}.

FromProjectLocationRepositoryFile(String, String, String, String)

public static FileName FromProjectLocationRepositoryFile(string projectId, string locationId, string repositoryId, string fileId)

Creates a FileName with the pattern projects/{project}/locations/{location}/repositories/{repository}/files/{file}.

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.
fileId String

The File ID. Must not be null or empty.
Returns
Type Description
FileName

A new instance of FileName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FileName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

A new instance of FileName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
Int32
Overrides

Parse(String)

public static FileName Parse(string fileName)

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

Parameter
Name Description
fileName String

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

The parsed FileName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/files/{file}

Parse(String, Boolean)

public static FileName Parse(string fileName, bool allowUnparsed)

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

Parameters
Name Description
fileName String

The resource name in string form. Must not be null.
allowUnparsed Boolean

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
FileName

The parsed FileName if successful.
Remarks

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

  • projects/{project}/locations/{location}/repositories/{repository}/files/{file}
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 FileName)

public static bool TryParse(string fileName, out FileName result)

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

Parameters
Name Description
fileName String

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

When this method returns, the parsed FileName, or null if parsing failed.
Returns
Type Description
Boolean

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}/files/{file}

TryParse(String, Boolean, out FileName)

public static bool TryParse(string fileName, bool allowUnparsed, out FileName result)

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

Parameters
Name Description
fileName String

The resource name in string form. Must not be null.
allowUnparsed Boolean

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 FileName

When this method returns, the parsed FileName, or null if parsing failed.
Returns
Type Description
Boolean

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}/files/{file}
Or may be in any format if allowUnparsed is true.

Operators

Equality(FileName, FileName)

public static bool operator ==(FileName a, FileName b)
Parameters
Name Description
a FileName
b FileName
Returns
Type Description
Boolean

Inequality(FileName, FileName)

public static bool operator !=(FileName a, FileName b)
Parameters
Name Description
a FileName
b FileName
Returns
Type Description
Boolean