Config Delivery v1beta API - Class ResourceBundleName (1.0.0-beta01) 

public sealed class ResourceBundleName : IResourceName, IEquatable<ResourceBundleName>

Reference documentation and code samples for the Config Delivery v1beta API class ResourceBundleName.

Resource name for the ResourceBundle resource.

Inheritance

object > ResourceBundleName

Namespace

Google.Cloud.ConfigDelivery.V1Beta

Assembly

Google.Cloud.ConfigDelivery.V1Beta.dll

Constructors

ResourceBundleName(string, string, string)

public ResourceBundleName(string projectId, string locationId, string resourceBundleId)

Constructs a new instance of a ResourceBundleName class from the component parts of pattern projects/{project}/locations/{location}/resourceBundles/{resource_bundle}

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

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

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

ResourceBundleId

public string ResourceBundleId { get; }

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

Property Value
Type Description
string

Type

public ResourceBundleName.ResourceNameType Type { get; }

The ResourceBundleName.ResourceNameType of the contained resource name.

Property Value
Type Description
ResourceBundleNameResourceNameType

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

Formats the IDs into the string representation of this ResourceBundleName with pattern projects/{project}/locations/{location}/resourceBundles/{resource_bundle}.

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

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

The string representation of this ResourceBundleName with pattern projects/{project}/locations/{location}/resourceBundles/{resource_bundle}.

FormatProjectLocationResourceBundle(string, string, string)

public static string FormatProjectLocationResourceBundle(string projectId, string locationId, string resourceBundleId)

Formats the IDs into the string representation of this ResourceBundleName with pattern projects/{project}/locations/{location}/resourceBundles/{resource_bundle}.

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

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

The string representation of this ResourceBundleName with pattern projects/{project}/locations/{location}/resourceBundles/{resource_bundle}.

FromProjectLocationResourceBundle(string, string, string)

public static ResourceBundleName FromProjectLocationResourceBundle(string projectId, string locationId, string resourceBundleId)

Creates a ResourceBundleName with the pattern projects/{project}/locations/{location}/resourceBundles/{resource_bundle}.

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

The ResourceBundle ID. Must not be null or empty.
Returns
Type Description
ResourceBundleName

A new instance of ResourceBundleName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ResourceBundleName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ResourceBundleName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
resourceBundleName string

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

The parsed ResourceBundleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/resourceBundles/{resource_bundle}

Parse(string, bool)

public static ResourceBundleName Parse(string resourceBundleName, bool allowUnparsed)

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

Parameters
Name Description
resourceBundleName 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
ResourceBundleName

The parsed ResourceBundleName if successful.
Remarks

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

  • projects/{project}/locations/{location}/resourceBundles/{resource_bundle}

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

public static bool TryParse(string resourceBundleName, out ResourceBundleName result)

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

Parameters
Name Description
resourceBundleName string

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

When this method returns, the parsed ResourceBundleName, 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}/resourceBundles/{resource_bundle}

TryParse(string, bool, out ResourceBundleName)

public static bool TryParse(string resourceBundleName, bool allowUnparsed, out ResourceBundleName result)

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

Parameters
Name Description
resourceBundleName 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 ResourceBundleName

When this method returns, the parsed ResourceBundleName, 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}/resourceBundles/{resource_bundle}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ResourceBundleName, ResourceBundleName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ResourceBundleName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ResourceBundleName

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

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.