Cloud Security Compliance v1 API - Class FrameworkName (1.0.0-beta01) 

public sealed class FrameworkName : IResourceName, IEquatable<FrameworkName>

Reference documentation and code samples for the Cloud Security Compliance v1 API class FrameworkName.

Resource name for the Framework resource.

Inheritance

object > FrameworkName

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Constructors

FrameworkName(string, string, string)

public FrameworkName(string organizationId, string locationId, string frameworkId)

Constructs a new instance of a FrameworkName class from the component parts of pattern organizations/{organization}/locations/{location}/frameworks/{framework}

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

The Framework ID. Must not be null or empty.

Properties

FrameworkId

public string FrameworkId { get; }

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

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

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

Type

public FrameworkName.ResourceNameType Type { get; }

The FrameworkName.ResourceNameType of the contained resource name.

Property Value
Type Description
FrameworkNameResourceNameType

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 organizationId, string locationId, string frameworkId)

Formats the IDs into the string representation of this FrameworkName with pattern organizations/{organization}/locations/{location}/frameworks/{framework}.

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

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

The string representation of this FrameworkName with pattern organizations/{organization}/locations/{location}/frameworks/{framework}.

FormatOrganizationLocationFramework(string, string, string)

public static string FormatOrganizationLocationFramework(string organizationId, string locationId, string frameworkId)

Formats the IDs into the string representation of this FrameworkName with pattern organizations/{organization}/locations/{location}/frameworks/{framework}.

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

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

The string representation of this FrameworkName with pattern organizations/{organization}/locations/{location}/frameworks/{framework}.

FromOrganizationLocationFramework(string, string, string)

public static FrameworkName FromOrganizationLocationFramework(string organizationId, string locationId, string frameworkId)

Creates a FrameworkName with the pattern organizations/{organization}/locations/{location}/frameworks/{framework}.

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

The Framework ID. Must not be null or empty.
Returns
Type Description
FrameworkName

A new instance of FrameworkName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static FrameworkName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FrameworkName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
frameworkName string

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

The parsed FrameworkName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/frameworks/{framework}

Parse(string, bool)

public static FrameworkName Parse(string frameworkName, bool allowUnparsed)

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

Parameters
Name Description
frameworkName 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
FrameworkName

The parsed FrameworkName if successful.
Remarks

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

  • organizations/{organization}/locations/{location}/frameworks/{framework}
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 FrameworkName)

public static bool TryParse(string frameworkName, out FrameworkName result)

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

Parameters
Name Description
frameworkName string

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

When this method returns, the parsed FrameworkName, 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}/locations/{location}/frameworks/{framework}

TryParse(string, bool, out FrameworkName)

public static bool TryParse(string frameworkName, bool allowUnparsed, out FrameworkName result)

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

Parameters
Name Description
frameworkName 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 FrameworkName

When this method returns, the parsed FrameworkName, 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}/locations/{location}/frameworks/{framework}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(FrameworkName, FrameworkName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a FrameworkName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a FrameworkName

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

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.