Security Center Management v1 API - Class SecurityCenterServiceName (1.2.0)

public sealed class SecurityCenterServiceName : IResourceName, IEquatable<SecurityCenterServiceName>

Reference documentation and code samples for the Security Center Management v1 API class SecurityCenterServiceName.

Resource name for the SecurityCenterService resource.

Inheritance

object > SecurityCenterServiceName

Implements

IResourceName, IEquatable SecurityCenterServiceName

Inherited Members

object.GetType()

Namespace

Google.Cloud.SecurityCenterManagement.V1

Assembly

Google.Cloud.SecurityCenterManagement.V1.dll

Constructors

SecurityCenterServiceName(string, string, string)

public SecurityCenterServiceName(string projectId, string locationId, string serviceId)

Constructs a new instance of a SecurityCenterServiceName class from the component parts of pattern projects/{project}/locations/{location}/securityCenterServices/{service}

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.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.

Properties

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`

ServiceId

public string ServiceId { get; }

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

Property Value
Type	Description
`string`

Type

public SecurityCenterServiceName.ResourceNameType Type { get; }

The SecurityCenterServiceName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SecurityCenterServiceNameResourceNameType`

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

Formats the IDs into the string representation of this SecurityCenterServiceName with pattern projects/{project}/locations/{location}/securityCenterServices/{service}.

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.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityCenterServiceName with pattern `projects/{project}/locations/{location}/securityCenterServices/{service}`.

FormatFolderLocationService(string, string, string)

public static string FormatFolderLocationService(string folderId, string locationId, string serviceId)

Formats the IDs into the string representation of this SecurityCenterServiceName with pattern folders/{folder}/locations/{location}/securityCenterServices/{service}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityCenterServiceName with pattern `folders/{folder}/locations/{location}/securityCenterServices/{service}`.

FormatOrganizationLocationService(string, string, string)

public static string FormatOrganizationLocationService(string organizationId, string locationId, string serviceId)

Formats the IDs into the string representation of this SecurityCenterServiceName with pattern organizations/{organization}/locations/{location}/securityCenterServices/{service}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityCenterServiceName with pattern `organizations/{organization}/locations/{location}/securityCenterServices/{service}`.

FormatProjectLocationService(string, string, string)

public static string FormatProjectLocationService(string projectId, string locationId, string serviceId)

Formats the IDs into the string representation of this SecurityCenterServiceName with pattern projects/{project}/locations/{location}/securityCenterServices/{service}.

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.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SecurityCenterServiceName with pattern `projects/{project}/locations/{location}/securityCenterServices/{service}`.

FromFolderLocationService(string, string, string)

public static SecurityCenterServiceName FromFolderLocationService(string folderId, string locationId, string serviceId)

Creates a SecurityCenterServiceName with the pattern folders/{folder}/locations/{location}/securityCenterServices/{service}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.

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

FromOrganizationLocationService(string, string, string)

public static SecurityCenterServiceName FromOrganizationLocationService(string organizationId, string locationId, string serviceId)

Creates a SecurityCenterServiceName with the pattern organizations/{organization}/locations/{location}/securityCenterServices/{service}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.

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

FromProjectLocationService(string, string, string)

public static SecurityCenterServiceName FromProjectLocationService(string projectId, string locationId, string serviceId)

Creates a SecurityCenterServiceName with the pattern projects/{project}/locations/{location}/securityCenterServices/{service}.

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.
`serviceId`	`string` The `Service` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static SecurityCenterServiceName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SecurityCenterServiceName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static SecurityCenterServiceName Parse(string securityCenterServiceName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/securityCenterServices/{service}
folders/{folder}/locations/{location}/securityCenterServices/{service}
organizations/{organization}/locations/{location}/securityCenterServices/{service}

Parse(string, bool)

public static SecurityCenterServiceName Parse(string securityCenterServiceName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/securityCenterServices/{service}
folders/{folder}/locations/{location}/securityCenterServices/{service}
organizations/{organization}/locations/{location}/securityCenterServices/{service}

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

public static bool TryParse(string securityCenterServiceName, out SecurityCenterServiceName result)

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

Parameters
Name	Description
`securityCenterServiceName`	`string` The resource name in string form. Must not be `null`.
`result`	`SecurityCenterServiceName` When this method returns, the parsed SecurityCenterServiceName, 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}/securityCenterServices/{service}
folders/{folder}/locations/{location}/securityCenterServices/{service}
organizations/{organization}/locations/{location}/securityCenterServices/{service}

TryParse(string, bool, out SecurityCenterServiceName)

public static bool TryParse(string securityCenterServiceName, bool allowUnparsed, out SecurityCenterServiceName result)

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

Parameters
Name	Description
`securityCenterServiceName`	`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`	`SecurityCenterServiceName` When this method returns, the parsed SecurityCenterServiceName, 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}/securityCenterServices/{service}
folders/{folder}/locations/{location}/securityCenterServices/{service}
organizations/{organization}/locations/{location}/securityCenterServices/{service}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SecurityCenterServiceName, SecurityCenterServiceName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`SecurityCenterServiceName` The first resource name to compare, or null.
`b`	`SecurityCenterServiceName` 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 !=(SecurityCenterServiceName, SecurityCenterServiceName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`SecurityCenterServiceName` The first resource name to compare, or null.
`b`	`SecurityCenterServiceName` 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.