Storage Batch Operations v1 API - Class BucketOperationName (1.0.0-beta05) 

public sealed class BucketOperationName : IResourceName, IEquatable<BucketOperationName>

Reference documentation and code samples for the Storage Batch Operations v1 API class BucketOperationName.

Resource name for the BucketOperation resource.

Inheritance

object > BucketOperationName

Namespace

Google.Cloud.StorageBatchOperations.V1

Assembly

Google.Cloud.StorageBatchOperations.V1.dll

Constructors

BucketOperationName(string, string, string, string)

public BucketOperationName(string projectId, string locationId, string jobId, string bucketOperationId)

Constructs a new instance of a BucketOperationName class from the component parts of pattern projects/{project}/locations/{location}/jobs/{job}/bucketOperations/{bucket_operation}

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

The Job ID. Must not be null or empty.
bucketOperationId string

The BucketOperation ID. Must not be null or empty.

Properties

BucketOperationId

public string BucketOperationId { get; }

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

JobId

public string JobId { get; }

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

Property Value
Type Description
string

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

Type

public BucketOperationName.ResourceNameType Type { get; }

The BucketOperationName.ResourceNameType of the contained resource name.

Property Value
Type Description
BucketOperationNameResourceNameType

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

Formats the IDs into the string representation of this BucketOperationName with pattern projects/{project}/locations/{location}/jobs/{job}/bucketOperations/{bucket_operation}.

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

The Job ID. Must not be null or empty.
bucketOperationId string

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

The string representation of this BucketOperationName with pattern projects/{project}/locations/{location}/jobs/{job}/bucketOperations/{bucket_operation}.

FormatProjectLocationJobBucketOperation(string, string, string, string)

public static string FormatProjectLocationJobBucketOperation(string projectId, string locationId, string jobId, string bucketOperationId)

Formats the IDs into the string representation of this BucketOperationName with pattern projects/{project}/locations/{location}/jobs/{job}/bucketOperations/{bucket_operation}.

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

The Job ID. Must not be null or empty.
bucketOperationId string

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

The string representation of this BucketOperationName with pattern projects/{project}/locations/{location}/jobs/{job}/bucketOperations/{bucket_operation}.

FromProjectLocationJobBucketOperation(string, string, string, string)

public static BucketOperationName FromProjectLocationJobBucketOperation(string projectId, string locationId, string jobId, string bucketOperationId)

Creates a BucketOperationName with the pattern projects/{project}/locations/{location}/jobs/{job}/bucketOperations/{bucket_operation}.

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

The Job ID. Must not be null or empty.
bucketOperationId string

The BucketOperation ID. Must not be null or empty.
Returns
Type Description
BucketOperationName

A new instance of BucketOperationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BucketOperationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BucketOperationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
bucketOperationName string

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

The parsed BucketOperationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/jobs/{job}/bucketOperations/{bucket_operation}

Parse(string, bool)

public static BucketOperationName Parse(string bucketOperationName, bool allowUnparsed)

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

Parameters
Name Description
bucketOperationName 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
BucketOperationName

The parsed BucketOperationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/jobs/{job}/bucketOperations/{bucket_operation}

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

public static bool TryParse(string bucketOperationName, out BucketOperationName result)

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

Parameters
Name Description
bucketOperationName string

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

When this method returns, the parsed BucketOperationName, 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}/jobs/{job}/bucketOperations/{bucket_operation}

TryParse(string, bool, out BucketOperationName)

public static bool TryParse(string bucketOperationName, bool allowUnparsed, out BucketOperationName result)

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

Parameters
Name Description
bucketOperationName 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 BucketOperationName

When this method returns, the parsed BucketOperationName, 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}/jobs/{job}/bucketOperations/{bucket_operation}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BucketOperationName, BucketOperationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BucketOperationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BucketOperationName

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

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.