Class SettingsName (1.0.0-beta04)

public sealed class SettingsName : IResourceName, IEquatable<SettingsName>

Resource name for the Settings resource.

Inheritance

Object > SettingsName

Implements

IResourceName, IEquatable<SettingsName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.SecurityCenter.Settings.V1Beta1

Assembly

Google.Cloud.SecurityCenter.Settings.V1Beta1.dll

Constructors

SettingsName(String)

public SettingsName(string organizationId)

Constructs a new instance of a SettingsName class from the component parts of pattern organizations/{organization}/settings

Parameter
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.

Properties

ClusterId

public string ClusterId { get; }

The Cluster ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

RegionId

public string RegionId { get; }

The Region ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

Type

public SettingsName.ResourceNameType Type { get; }

The SettingsName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SettingsName.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`

ZoneId

public string ZoneId { get; }

The Zone ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`String`

Methods

Format(String)

public static string Format(string organizationId)

Formats the IDs into the string representation of this SettingsName with pattern organizations/{organization}/settings.

Parameter
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SettingsName with pattern `organizations/{organization}/settings`.

FormatFolder(String)

public static string FormatFolder(string folderId)

Formats the IDs into the string representation of this SettingsName with pattern folders/{folder}/settings.

Parameter
Name	Description
`folderId`	`String` The `Folder` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SettingsName with pattern `folders/{folder}/settings`.

FormatOrganization(String)

public static string FormatOrganization(string organizationId)

Formats the IDs into the string representation of this SettingsName with pattern organizations/{organization}/settings.

Parameter
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SettingsName with pattern `organizations/{organization}/settings`.

FormatProject(String)

public static string FormatProject(string projectId)

Formats the IDs into the string representation of this SettingsName with pattern projects/{project}/settings.

Parameter
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SettingsName with pattern `projects/{project}/settings` .

FormatProjectLocationCluster(String, String, String)

public static string FormatProjectLocationCluster(string projectId, string locationId, string clusterId)

Formats the IDs into the string representation of this SettingsName with pattern projects/{project}/locations/{location}/clusters/{cluster}/settings.

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.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SettingsName with pattern `projects/{project}/locations/{location}/clusters/{cluster}/settings`.

FormatProjectRegionCluster(String, String, String)

public static string FormatProjectRegionCluster(string projectId, string regionId, string clusterId)

Formats the IDs into the string representation of this SettingsName with pattern projects/{project}/regions/{region}/clusters/{cluster}/settings.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`regionId`	`String` The `Region` ID. Must not be `null` or empty.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SettingsName with pattern `projects/{project}/regions/{region}/clusters/{cluster}/settings`.

FormatProjectZoneCluster(String, String, String)

public static string FormatProjectZoneCluster(string projectId, string zoneId, string clusterId)

Formats the IDs into the string representation of this SettingsName with pattern projects/{project}/zones/{zone}/clusters/{cluster}/settings.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`zoneId`	`String` The `Zone` ID. Must not be `null` or empty.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this SettingsName with pattern `projects/{project}/zones/{zone}/clusters/{cluster}/settings`.

FromFolder(String)

public static SettingsName FromFolder(string folderId)

Creates a SettingsName with the pattern folders/{folder}/settings.

Parameter
Name	Description
`folderId`	`String` The `Folder` ID. Must not be `null` or empty.

Returns
Type	Description
`SettingsName`	A new instance of SettingsName constructed from the provided ids.

FromOrganization(String)

public static SettingsName FromOrganization(string organizationId)

Creates a SettingsName with the pattern organizations/{organization}/settings.

Parameter
Name	Description
`organizationId`	`String` The `Organization` ID. Must not be `null` or empty.

Returns
Type	Description
`SettingsName`	A new instance of SettingsName constructed from the provided ids.

FromProject(String)

public static SettingsName FromProject(string projectId)

Creates a SettingsName with the pattern projects/{project}/settings.

Parameter
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`SettingsName`	A new instance of SettingsName constructed from the provided ids.

FromProjectLocationCluster(String, String, String)

public static SettingsName FromProjectLocationCluster(string projectId, string locationId, string clusterId)

Creates a SettingsName with the pattern projects/{project}/locations/{location}/clusters/{cluster}/settings.

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.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`SettingsName`	A new instance of SettingsName constructed from the provided ids.

FromProjectRegionCluster(String, String, String)

public static SettingsName FromProjectRegionCluster(string projectId, string regionId, string clusterId)

Creates a SettingsName with the pattern projects/{project}/regions/{region}/clusters/{cluster}/settings.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`regionId`	`String` The `Region` ID. Must not be `null` or empty.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`SettingsName`	A new instance of SettingsName constructed from the provided ids.

FromProjectZoneCluster(String, String, String)

public static SettingsName FromProjectZoneCluster(string projectId, string zoneId, string clusterId)

Creates a SettingsName with the pattern projects/{project}/zones/{zone}/clusters/{cluster}/settings.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`zoneId`	`String` The `Zone` ID. Must not be `null` or empty.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`SettingsName`	A new instance of SettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SettingsName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`SettingsName`	A new instance of SettingsName containing the provided `unparsedResourceName` .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static SettingsName Parse(string settingsName)

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

Parameter
Name	Description
`settingsName`	`String` The resource name in string form. Must not be `null`.

Returns
Type	Description
`SettingsName`	The parsed SettingsName if successful.

Remarks

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

organizations/{organization}/settings
folders/{folder}/settings
projects/{project}/settings
projects/{project}/locations/{location}/clusters/{cluster}/settings
projects/{project}/regions/{region}/clusters/{cluster}/settings
projects/{project}/zones/{zone}/clusters/{cluster}/settings

Parse(String, Boolean)

public static SettingsName Parse(string settingsName, bool allowUnparsed)

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

Parameters
Name	Description
`settingsName`	`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
`SettingsName`	The parsed SettingsName if successful.

Remarks

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

organizations/{organization}/settings
folders/{folder}/settings
projects/{project}/settings
projects/{project}/locations/{location}/clusters/{cluster}/settings
projects/{project}/regions/{region}/clusters/{cluster}/settings
projects/{project}/zones/{zone}/clusters/{cluster}/settings

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

Object.ToString()

TryParse(String, out SettingsName)

public static bool TryParse(string settingsName, out SettingsName result)

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

Parameters
Name	Description
`settingsName`	`String` The resource name in string form. Must not be `null`.
`result`	`SettingsName` When this method returns, the parsed SettingsName, 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:

organizations/{organization}/settings
folders/{folder}/settings
projects/{project}/settings
projects/{project}/locations/{location}/clusters/{cluster}/settings
projects/{project}/regions/{region}/clusters/{cluster}/settings
projects/{project}/zones/{zone}/clusters/{cluster}/settings

TryParse(String, Boolean, out SettingsName)

public static bool TryParse(string settingsName, bool allowUnparsed, out SettingsName result)

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

Parameters
Name	Description
`settingsName`	`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`	`SettingsName` When this method returns, the parsed SettingsName, 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:

organizations/{organization}/settings
folders/{folder}/settings
projects/{project}/settings
projects/{project}/locations/{location}/clusters/{cluster}/settings
projects/{project}/regions/{region}/clusters/{cluster}/settings
projects/{project}/zones/{zone}/clusters/{cluster}/settings

Or may be in any format if allowUnparsed is true.

Operators

Equality(SettingsName, SettingsName)

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

Parameters
Name	Description
`a`	`SettingsName`
`b`	`SettingsName`

Returns
Type	Description
`Boolean`

Inequality(SettingsName, SettingsName)

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

Parameters
Name	Description
`a`	`SettingsName`
`b`	`SettingsName`

Returns
Type	Description
`Boolean`