Google Cloud Security Command Center Settings v1beta1 API - Class SettingsName (2.0.0-beta05) 

public sealed class SettingsName : IResourceName, IEquatable<SettingsName>

Reference documentation and code samples for the Google Cloud Security Command Center Settings v1beta1 API class SettingsName.

Resource name for the Settings resource.

Inheritance

object > SettingsName

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
bool

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
SettingsNameResourceNameType

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
int
Overrides

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, bool)

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

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
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:

  • 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, bool, 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 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 SettingsName

When this method returns, the parsed SettingsName, 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:

  • 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

operator ==(SettingsName, SettingsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SettingsName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SettingsName

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

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.