Cloud Storage v2 API - Class ObjectName (1.10.0) 

public sealed class ObjectName : IResourceName, IEquatable<ObjectName>

Reference documentation and code samples for the Cloud Storage v2 API class ObjectName.

Resource name for the Object resource.

Inheritance

object > ObjectName

Namespace

Google.Cloud.Storage.Control.V2

Assembly

Google.Cloud.Storage.Control.V2.dll

Constructors

ObjectName(string, string, string)

public ObjectName(string projectId, string bucketId, string objectId)

Constructs a new instance of a ObjectName class from the component parts of pattern projects/{project}/buckets/{bucket}/objects/{object}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
bucketId string

The Bucket ID. Must not be null or empty.
objectId string

The Object ID. Must not be null or empty.

Properties

BucketId

public string BucketId { get; }

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

ObjectId

public string ObjectId { get; }

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

The ObjectName.ResourceNameType of the contained resource name.

Property Value
Type Description
ObjectNameResourceNameType

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

Formats the IDs into the string representation of this ObjectName with pattern projects/{project}/buckets/{bucket}/objects/{object}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
bucketId string

The Bucket ID. Must not be null or empty.
objectId string

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

The string representation of this ObjectName with pattern projects/{project}/buckets/{bucket}/objects/{object}.

FormatProjectBucketObject(string, string, string)

public static string FormatProjectBucketObject(string projectId, string bucketId, string objectId)

Formats the IDs into the string representation of this ObjectName with pattern projects/{project}/buckets/{bucket}/objects/{object}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
bucketId string

The Bucket ID. Must not be null or empty.
objectId string

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

The string representation of this ObjectName with pattern projects/{project}/buckets/{bucket}/objects/{object}.

FromProjectBucketObject(string, string, string)

public static ObjectName FromProjectBucketObject(string projectId, string bucketId, string objectId)

Creates a ObjectName with the pattern projects/{project}/buckets/{bucket}/objects/{object} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
bucketId string

The Bucket ID. Must not be null or empty.
objectId string

The Object ID. Must not be null or empty.
Returns
Type Description
ObjectName

A new instance of ObjectName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ObjectName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ObjectName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
objectName string

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

The parsed ObjectName if successful.
Remarks

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

  • projects/{project}/buckets/{bucket}/objects/{object}

Parse(string, bool)

public static ObjectName Parse(string objectName, bool allowUnparsed)

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

Parameters
Name Description
objectName 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
ObjectName

The parsed ObjectName if successful.
Remarks

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

  • projects/{project}/buckets/{bucket}/objects/{object}

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

public static bool TryParse(string objectName, out ObjectName result)

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

Parameters
Name Description
objectName string

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

When this method returns, the parsed ObjectName, 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}/buckets/{bucket}/objects/{object}

TryParse(string, bool, out ObjectName)

public static bool TryParse(string objectName, bool allowUnparsed, out ObjectName result)

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

Parameters
Name Description
objectName 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 ObjectName

When this method returns, the parsed ObjectName, 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}/buckets/{bucket}/objects/{object}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ObjectName, ObjectName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ObjectName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ObjectName

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

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.