Cloud Security Compliance v1 API - Class AuditClient (1.0.0-beta04) 

public abstract class AuditClient

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

Audit client wrapper, for convenient use.

Inheritance

object > AuditClient

Derived Types

Namespace

Google.Cloud.CloudSecurityCompliance.V1

Assembly

Google.Cloud.CloudSecurityCompliance.V1.dll

Remarks

Service describing handlers for resources

Properties

CreateFrameworkAuditOperationsClient

public virtual OperationsClient CreateFrameworkAuditOperationsClient { get; }

The long-running operations client for CreateFrameworkAudit.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the Audit service, which is a host of "cloudsecuritycompliance.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default Audit scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default Audit scopes are:

GrpcClient

public virtual Audit.AuditClient GrpcClient { get; }

The underlying gRPC Audit client

Property Value
Type Description
AuditAuditClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static AuditClient Create()

Synchronously creates a AuditClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AuditClientBuilder.

Returns
Type Description
AuditClient

The created AuditClient.

CreateAsync(CancellationToken)

public static Task<AuditClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a AuditClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use AuditClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskAuditClient

The task representing the created AuditClient.

CreateFrameworkAudit(LocationName, FrameworkAudit, string, CallSettings)

public virtual Operation<FrameworkAudit, OperationMetadata> CreateFrameworkAudit(LocationName parent, FrameworkAudit frameworkAudit, string frameworkAuditId, CallSettings callSettings = null)

Creates an audit scope report for a framework.

Parameters
Name Description
parent LocationName

Required. The parent resource where this framework audit is created.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
frameworkAudit FrameworkAudit

Required. The framework audit to create.
frameworkAuditId string

Optional. The ID to use for the framework audit. The ID becomes the final component of the framework audit's full resource name.

The ID must be between 4-63 characters, and valid characters are \[a-z][0-9]-\.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFrameworkAuditOperationMetadata

The RPC response.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
FrameworkAudit frameworkAudit = new FrameworkAudit();
string frameworkAuditId = "";
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = auditClient.CreateFrameworkAudit(parent, frameworkAudit, frameworkAuditId);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = auditClient.PollOnceCreateFrameworkAudit(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAudit(CreateFrameworkAuditRequest, CallSettings)

public virtual Operation<FrameworkAudit, OperationMetadata> CreateFrameworkAudit(CreateFrameworkAuditRequest request, CallSettings callSettings = null)

Creates an audit scope report for a framework.

Parameters
Name Description
request CreateFrameworkAuditRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFrameworkAuditOperationMetadata

The RPC response.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
CreateFrameworkAuditRequest request = new CreateFrameworkAuditRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    FrameworkAuditId = "",
    FrameworkAudit = new FrameworkAudit(),
};
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = auditClient.CreateFrameworkAudit(request);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = auditClient.PollOnceCreateFrameworkAudit(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAudit(OrganizationLocationName, FrameworkAudit, string, CallSettings)

public virtual Operation<FrameworkAudit, OperationMetadata> CreateFrameworkAudit(OrganizationLocationName parent, FrameworkAudit frameworkAudit, string frameworkAuditId, CallSettings callSettings = null)

Creates an audit scope report for a framework.

Parameters
Name Description
parent OrganizationLocationName

Required. The parent resource where this framework audit is created.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
frameworkAudit FrameworkAudit

Required. The framework audit to create.
frameworkAuditId string

Optional. The ID to use for the framework audit. The ID becomes the final component of the framework audit's full resource name.

The ID must be between 4-63 characters, and valid characters are \[a-z][0-9]-\.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFrameworkAuditOperationMetadata

The RPC response.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
FrameworkAudit frameworkAudit = new FrameworkAudit();
string frameworkAuditId = "";
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = auditClient.CreateFrameworkAudit(parent, frameworkAudit, frameworkAuditId);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = auditClient.PollOnceCreateFrameworkAudit(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAudit(string, FrameworkAudit, string, CallSettings)

public virtual Operation<FrameworkAudit, OperationMetadata> CreateFrameworkAudit(string parent, FrameworkAudit frameworkAudit, string frameworkAuditId, CallSettings callSettings = null)

Creates an audit scope report for a framework.

Parameters
Name Description
parent string

Required. The parent resource where this framework audit is created.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
frameworkAudit FrameworkAudit

Required. The framework audit to create.
frameworkAuditId string

Optional. The ID to use for the framework audit. The ID becomes the final component of the framework audit's full resource name.

The ID must be between 4-63 characters, and valid characters are \[a-z][0-9]-\.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFrameworkAuditOperationMetadata

The RPC response.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
FrameworkAudit frameworkAudit = new FrameworkAudit();
string frameworkAuditId = "";
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = auditClient.CreateFrameworkAudit(parent, frameworkAudit, frameworkAuditId);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = auditClient.PollOnceCreateFrameworkAudit(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAuditAsync(LocationName, FrameworkAudit, string, CallSettings)

public virtual Task<Operation<FrameworkAudit, OperationMetadata>> CreateFrameworkAuditAsync(LocationName parent, FrameworkAudit frameworkAudit, string frameworkAuditId, CallSettings callSettings = null)

Creates an audit scope report for a framework.

Parameters
Name Description
parent LocationName

Required. The parent resource where this framework audit is created.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
frameworkAudit FrameworkAudit

Required. The framework audit to create.
frameworkAuditId string

Optional. The ID to use for the framework audit. The ID becomes the final component of the framework audit's full resource name.

The ID must be between 4-63 characters, and valid characters are \[a-z][0-9]-\.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFrameworkAuditOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
FrameworkAudit frameworkAudit = new FrameworkAudit();
string frameworkAuditId = "";
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = await auditClient.CreateFrameworkAuditAsync(parent, frameworkAudit, frameworkAuditId);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = await auditClient.PollOnceCreateFrameworkAuditAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAuditAsync(LocationName, FrameworkAudit, string, CancellationToken)

public virtual Task<Operation<FrameworkAudit, OperationMetadata>> CreateFrameworkAuditAsync(LocationName parent, FrameworkAudit frameworkAudit, string frameworkAuditId, CancellationToken cancellationToken)

Creates an audit scope report for a framework.

Parameters
Name Description
parent LocationName

Required. The parent resource where this framework audit is created.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
frameworkAudit FrameworkAudit

Required. The framework audit to create.
frameworkAuditId string

Optional. The ID to use for the framework audit. The ID becomes the final component of the framework audit's full resource name.

The ID must be between 4-63 characters, and valid characters are \[a-z][0-9]-\.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationFrameworkAuditOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
FrameworkAudit frameworkAudit = new FrameworkAudit();
string frameworkAuditId = "";
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = await auditClient.CreateFrameworkAuditAsync(parent, frameworkAudit, frameworkAuditId);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = await auditClient.PollOnceCreateFrameworkAuditAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAuditAsync(CreateFrameworkAuditRequest, CallSettings)

public virtual Task<Operation<FrameworkAudit, OperationMetadata>> CreateFrameworkAuditAsync(CreateFrameworkAuditRequest request, CallSettings callSettings = null)

Creates an audit scope report for a framework.

Parameters
Name Description
request CreateFrameworkAuditRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFrameworkAuditOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
CreateFrameworkAuditRequest request = new CreateFrameworkAuditRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    FrameworkAuditId = "",
    FrameworkAudit = new FrameworkAudit(),
};
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = await auditClient.CreateFrameworkAuditAsync(request);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = await auditClient.PollOnceCreateFrameworkAuditAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAuditAsync(CreateFrameworkAuditRequest, CancellationToken)

public virtual Task<Operation<FrameworkAudit, OperationMetadata>> CreateFrameworkAuditAsync(CreateFrameworkAuditRequest request, CancellationToken cancellationToken)

Creates an audit scope report for a framework.

Parameters
Name Description
request CreateFrameworkAuditRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationFrameworkAuditOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
CreateFrameworkAuditRequest request = new CreateFrameworkAuditRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    FrameworkAuditId = "",
    FrameworkAudit = new FrameworkAudit(),
};
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = await auditClient.CreateFrameworkAuditAsync(request);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = await auditClient.PollOnceCreateFrameworkAuditAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAuditAsync(OrganizationLocationName, FrameworkAudit, string, CallSettings)

public virtual Task<Operation<FrameworkAudit, OperationMetadata>> CreateFrameworkAuditAsync(OrganizationLocationName parent, FrameworkAudit frameworkAudit, string frameworkAuditId, CallSettings callSettings = null)

Creates an audit scope report for a framework.

Parameters
Name Description
parent OrganizationLocationName

Required. The parent resource where this framework audit is created.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
frameworkAudit FrameworkAudit

Required. The framework audit to create.
frameworkAuditId string

Optional. The ID to use for the framework audit. The ID becomes the final component of the framework audit's full resource name.

The ID must be between 4-63 characters, and valid characters are \[a-z][0-9]-\.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFrameworkAuditOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
FrameworkAudit frameworkAudit = new FrameworkAudit();
string frameworkAuditId = "";
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = await auditClient.CreateFrameworkAuditAsync(parent, frameworkAudit, frameworkAuditId);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = await auditClient.PollOnceCreateFrameworkAuditAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAuditAsync(OrganizationLocationName, FrameworkAudit, string, CancellationToken)

public virtual Task<Operation<FrameworkAudit, OperationMetadata>> CreateFrameworkAuditAsync(OrganizationLocationName parent, FrameworkAudit frameworkAudit, string frameworkAuditId, CancellationToken cancellationToken)

Creates an audit scope report for a framework.

Parameters
Name Description
parent OrganizationLocationName

Required. The parent resource where this framework audit is created.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
frameworkAudit FrameworkAudit

Required. The framework audit to create.
frameworkAuditId string

Optional. The ID to use for the framework audit. The ID becomes the final component of the framework audit's full resource name.

The ID must be between 4-63 characters, and valid characters are \[a-z][0-9]-\.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationFrameworkAuditOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
FrameworkAudit frameworkAudit = new FrameworkAudit();
string frameworkAuditId = "";
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = await auditClient.CreateFrameworkAuditAsync(parent, frameworkAudit, frameworkAuditId);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = await auditClient.PollOnceCreateFrameworkAuditAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAuditAsync(string, FrameworkAudit, string, CallSettings)

public virtual Task<Operation<FrameworkAudit, OperationMetadata>> CreateFrameworkAuditAsync(string parent, FrameworkAudit frameworkAudit, string frameworkAuditId, CallSettings callSettings = null)

Creates an audit scope report for a framework.

Parameters
Name Description
parent string

Required. The parent resource where this framework audit is created.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
frameworkAudit FrameworkAudit

Required. The framework audit to create.
frameworkAuditId string

Optional. The ID to use for the framework audit. The ID becomes the final component of the framework audit's full resource name.

The ID must be between 4-63 characters, and valid characters are \[a-z][0-9]-\.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFrameworkAuditOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
FrameworkAudit frameworkAudit = new FrameworkAudit();
string frameworkAuditId = "";
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = await auditClient.CreateFrameworkAuditAsync(parent, frameworkAudit, frameworkAuditId);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = await auditClient.PollOnceCreateFrameworkAuditAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

CreateFrameworkAuditAsync(string, FrameworkAudit, string, CancellationToken)

public virtual Task<Operation<FrameworkAudit, OperationMetadata>> CreateFrameworkAuditAsync(string parent, FrameworkAudit frameworkAudit, string frameworkAuditId, CancellationToken cancellationToken)

Creates an audit scope report for a framework.

Parameters
Name Description
parent string

Required. The parent resource where this framework audit is created.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
frameworkAudit FrameworkAudit

Required. The framework audit to create.
frameworkAuditId string

Optional. The ID to use for the framework audit. The ID becomes the final component of the framework audit's full resource name.

The ID must be between 4-63 characters, and valid characters are \[a-z][0-9]-\.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationFrameworkAuditOperationMetadata

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
FrameworkAudit frameworkAudit = new FrameworkAudit();
string frameworkAuditId = "";
// Make the request
Operation<FrameworkAudit, OperationMetadata> response = await auditClient.CreateFrameworkAuditAsync(parent, frameworkAudit, frameworkAuditId);

// Poll until the returned long-running operation is complete
Operation<FrameworkAudit, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
FrameworkAudit result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<FrameworkAudit, OperationMetadata> retrievedResponse = await auditClient.PollOnceCreateFrameworkAuditAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    FrameworkAudit retrievedResult = retrievedResponse.Result;
}

GenerateFrameworkAuditScopeReport(GenerateFrameworkAuditScopeReportRequest, CallSettings)

public virtual GenerateFrameworkAuditScopeReportResponse GenerateFrameworkAuditScopeReport(GenerateFrameworkAuditScopeReportRequest request, CallSettings callSettings = null)

Generates an audit scope report for a framework.

Parameters
Name Description
request GenerateFrameworkAuditScopeReportRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GenerateFrameworkAuditScopeReportResponse

The RPC response.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
GenerateFrameworkAuditScopeReportRequest request = new GenerateFrameworkAuditScopeReportRequest
{
    Scope = "",
    ReportFormat = GenerateFrameworkAuditScopeReportRequest.Types.Format.Unspecified,
    ComplianceFramework = "",
};
// Make the request
GenerateFrameworkAuditScopeReportResponse response = auditClient.GenerateFrameworkAuditScopeReport(request);

GenerateFrameworkAuditScopeReport(string, Format, string, CallSettings)

public virtual GenerateFrameworkAuditScopeReportResponse GenerateFrameworkAuditScopeReport(string scope, GenerateFrameworkAuditScopeReportRequest.Types.Format reportFormat, string complianceFramework, CallSettings callSettings = null)

Generates an audit scope report for a framework.

Parameters
Name Description
scope string

Required. The organization, folder or project for the audit report.

Supported formats are the following:

  • projects/{project_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
reportFormat GenerateFrameworkAuditScopeReportRequestTypesFormat

Required. The format that the scope report bytes is returned in.
complianceFramework string

Required. The compliance framework that the scope report is generated for.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
GenerateFrameworkAuditScopeReportResponse

The RPC response.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
string scope = "";
GenerateFrameworkAuditScopeReportRequest.Types.Format reportFormat = GenerateFrameworkAuditScopeReportRequest.Types.Format.Unspecified;
string complianceFramework = "";
// Make the request
GenerateFrameworkAuditScopeReportResponse response = auditClient.GenerateFrameworkAuditScopeReport(scope, reportFormat, complianceFramework);

GenerateFrameworkAuditScopeReportAsync(GenerateFrameworkAuditScopeReportRequest, CallSettings)

public virtual Task<GenerateFrameworkAuditScopeReportResponse> GenerateFrameworkAuditScopeReportAsync(GenerateFrameworkAuditScopeReportRequest request, CallSettings callSettings = null)

Generates an audit scope report for a framework.

Parameters
Name Description
request GenerateFrameworkAuditScopeReportRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGenerateFrameworkAuditScopeReportResponse

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
GenerateFrameworkAuditScopeReportRequest request = new GenerateFrameworkAuditScopeReportRequest
{
    Scope = "",
    ReportFormat = GenerateFrameworkAuditScopeReportRequest.Types.Format.Unspecified,
    ComplianceFramework = "",
};
// Make the request
GenerateFrameworkAuditScopeReportResponse response = await auditClient.GenerateFrameworkAuditScopeReportAsync(request);

GenerateFrameworkAuditScopeReportAsync(GenerateFrameworkAuditScopeReportRequest, CancellationToken)

public virtual Task<GenerateFrameworkAuditScopeReportResponse> GenerateFrameworkAuditScopeReportAsync(GenerateFrameworkAuditScopeReportRequest request, CancellationToken cancellationToken)

Generates an audit scope report for a framework.

Parameters
Name Description
request GenerateFrameworkAuditScopeReportRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskGenerateFrameworkAuditScopeReportResponse

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
GenerateFrameworkAuditScopeReportRequest request = new GenerateFrameworkAuditScopeReportRequest
{
    Scope = "",
    ReportFormat = GenerateFrameworkAuditScopeReportRequest.Types.Format.Unspecified,
    ComplianceFramework = "",
};
// Make the request
GenerateFrameworkAuditScopeReportResponse response = await auditClient.GenerateFrameworkAuditScopeReportAsync(request);

GenerateFrameworkAuditScopeReportAsync(string, Format, string, CallSettings)

public virtual Task<GenerateFrameworkAuditScopeReportResponse> GenerateFrameworkAuditScopeReportAsync(string scope, GenerateFrameworkAuditScopeReportRequest.Types.Format reportFormat, string complianceFramework, CallSettings callSettings = null)

Generates an audit scope report for a framework.

Parameters
Name Description
scope string

Required. The organization, folder or project for the audit report.

Supported formats are the following:

  • projects/{project_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
reportFormat GenerateFrameworkAuditScopeReportRequestTypesFormat

Required. The format that the scope report bytes is returned in.
complianceFramework string

Required. The compliance framework that the scope report is generated for.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskGenerateFrameworkAuditScopeReportResponse

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
string scope = "";
GenerateFrameworkAuditScopeReportRequest.Types.Format reportFormat = GenerateFrameworkAuditScopeReportRequest.Types.Format.Unspecified;
string complianceFramework = "";
// Make the request
GenerateFrameworkAuditScopeReportResponse response = await auditClient.GenerateFrameworkAuditScopeReportAsync(scope, reportFormat, complianceFramework);

GenerateFrameworkAuditScopeReportAsync(string, Format, string, CancellationToken)

public virtual Task<GenerateFrameworkAuditScopeReportResponse> GenerateFrameworkAuditScopeReportAsync(string scope, GenerateFrameworkAuditScopeReportRequest.Types.Format reportFormat, string complianceFramework, CancellationToken cancellationToken)

Generates an audit scope report for a framework.

Parameters
Name Description
scope string

Required. The organization, folder or project for the audit report.

Supported formats are the following:

  • projects/{project_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • organizations/{organization_id}/locations/{location}
reportFormat GenerateFrameworkAuditScopeReportRequestTypesFormat

Required. The format that the scope report bytes is returned in.
complianceFramework string

Required. The compliance framework that the scope report is generated for.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskGenerateFrameworkAuditScopeReportResponse

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
string scope = "";
GenerateFrameworkAuditScopeReportRequest.Types.Format reportFormat = GenerateFrameworkAuditScopeReportRequest.Types.Format.Unspecified;
string complianceFramework = "";
// Make the request
GenerateFrameworkAuditScopeReportResponse response = await auditClient.GenerateFrameworkAuditScopeReportAsync(scope, reportFormat, complianceFramework);

GetFrameworkAudit(FrameworkAuditName, CallSettings)

public virtual FrameworkAudit GetFrameworkAudit(FrameworkAuditName name, CallSettings callSettings = null)

Gets the details for a framework audit.

Parameters
Name Description
name FrameworkAuditName

Required. The name of the framework audit to retrieve.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • folders/{folder_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • projects/{project_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FrameworkAudit

The RPC response.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
FrameworkAuditName name = FrameworkAuditName.FromProjectLocationFrameworkAudit("[PROJECT]", "[LOCATION]", "[FRAMEWORK_AUDIT]");
// Make the request
FrameworkAudit response = auditClient.GetFrameworkAudit(name);

GetFrameworkAudit(GetFrameworkAuditRequest, CallSettings)

public virtual FrameworkAudit GetFrameworkAudit(GetFrameworkAuditRequest request, CallSettings callSettings = null)

Gets the details for a framework audit.

Parameters
Name Description
request GetFrameworkAuditRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FrameworkAudit

The RPC response.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
GetFrameworkAuditRequest request = new GetFrameworkAuditRequest
{
    FrameworkAuditName = FrameworkAuditName.FromProjectLocationFrameworkAudit("[PROJECT]", "[LOCATION]", "[FRAMEWORK_AUDIT]"),
};
// Make the request
FrameworkAudit response = auditClient.GetFrameworkAudit(request);

GetFrameworkAudit(string, CallSettings)

public virtual FrameworkAudit GetFrameworkAudit(string name, CallSettings callSettings = null)

Gets the details for a framework audit.

Parameters
Name Description
name string

Required. The name of the framework audit to retrieve.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • folders/{folder_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • projects/{project_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
FrameworkAudit

The RPC response.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/frameworkAudits/[FRAMEWORK_AUDIT]";
// Make the request
FrameworkAudit response = auditClient.GetFrameworkAudit(name);

GetFrameworkAuditAsync(FrameworkAuditName, CallSettings)

public virtual Task<FrameworkAudit> GetFrameworkAuditAsync(FrameworkAuditName name, CallSettings callSettings = null)

Gets the details for a framework audit.

Parameters
Name Description
name FrameworkAuditName

Required. The name of the framework audit to retrieve.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • folders/{folder_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • projects/{project_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFrameworkAudit

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
FrameworkAuditName name = FrameworkAuditName.FromProjectLocationFrameworkAudit("[PROJECT]", "[LOCATION]", "[FRAMEWORK_AUDIT]");
// Make the request
FrameworkAudit response = await auditClient.GetFrameworkAuditAsync(name);

GetFrameworkAuditAsync(FrameworkAuditName, CancellationToken)

public virtual Task<FrameworkAudit> GetFrameworkAuditAsync(FrameworkAuditName name, CancellationToken cancellationToken)

Gets the details for a framework audit.

Parameters
Name Description
name FrameworkAuditName

Required. The name of the framework audit to retrieve.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • folders/{folder_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • projects/{project_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskFrameworkAudit

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
FrameworkAuditName name = FrameworkAuditName.FromProjectLocationFrameworkAudit("[PROJECT]", "[LOCATION]", "[FRAMEWORK_AUDIT]");
// Make the request
FrameworkAudit response = await auditClient.GetFrameworkAuditAsync(name);

GetFrameworkAuditAsync(GetFrameworkAuditRequest, CallSettings)

public virtual Task<FrameworkAudit> GetFrameworkAuditAsync(GetFrameworkAuditRequest request, CallSettings callSettings = null)

Gets the details for a framework audit.

Parameters
Name Description
request GetFrameworkAuditRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFrameworkAudit

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
GetFrameworkAuditRequest request = new GetFrameworkAuditRequest
{
    FrameworkAuditName = FrameworkAuditName.FromProjectLocationFrameworkAudit("[PROJECT]", "[LOCATION]", "[FRAMEWORK_AUDIT]"),
};
// Make the request
FrameworkAudit response = await auditClient.GetFrameworkAuditAsync(request);

GetFrameworkAuditAsync(GetFrameworkAuditRequest, CancellationToken)

public virtual Task<FrameworkAudit> GetFrameworkAuditAsync(GetFrameworkAuditRequest request, CancellationToken cancellationToken)

Gets the details for a framework audit.

Parameters
Name Description
request GetFrameworkAuditRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskFrameworkAudit

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
GetFrameworkAuditRequest request = new GetFrameworkAuditRequest
{
    FrameworkAuditName = FrameworkAuditName.FromProjectLocationFrameworkAudit("[PROJECT]", "[LOCATION]", "[FRAMEWORK_AUDIT]"),
};
// Make the request
FrameworkAudit response = await auditClient.GetFrameworkAuditAsync(request);

GetFrameworkAuditAsync(string, CallSettings)

public virtual Task<FrameworkAudit> GetFrameworkAuditAsync(string name, CallSettings callSettings = null)

Gets the details for a framework audit.

Parameters
Name Description
name string

Required. The name of the framework audit to retrieve.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • folders/{folder_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • projects/{project_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskFrameworkAudit

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/frameworkAudits/[FRAMEWORK_AUDIT]";
// Make the request
FrameworkAudit response = await auditClient.GetFrameworkAuditAsync(name);

GetFrameworkAuditAsync(string, CancellationToken)

public virtual Task<FrameworkAudit> GetFrameworkAuditAsync(string name, CancellationToken cancellationToken)

Gets the details for a framework audit.

Parameters
Name Description
name string

Required. The name of the framework audit to retrieve.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • folders/{folder_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
  • projects/{project_id}/locations/{location}/frameworkAudits/{frameworkAuditName}
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskFrameworkAudit

A Task containing the RPC response.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/frameworkAudits/[FRAMEWORK_AUDIT]";
// Make the request
FrameworkAudit response = await auditClient.GetFrameworkAuditAsync(name);

ListFrameworkAudits(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> ListFrameworkAudits(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
parent LocationName

Required. The parent resource where the framework audits are listed.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListFrameworkAuditsResponseFrameworkAudit

A pageable sequence of FrameworkAudit resources.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> response = auditClient.ListFrameworkAudits(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (FrameworkAudit item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListFrameworkAuditsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (FrameworkAudit item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<FrameworkAudit> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (FrameworkAudit item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListFrameworkAudits(ListFrameworkAuditsRequest, CallSettings)

public virtual PagedEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> ListFrameworkAudits(ListFrameworkAuditsRequest request, CallSettings callSettings = null)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
request ListFrameworkAuditsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListFrameworkAuditsResponseFrameworkAudit

A pageable sequence of FrameworkAudit resources.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
ListFrameworkAuditsRequest request = new ListFrameworkAuditsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
};
// Make the request
PagedEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> response = auditClient.ListFrameworkAudits(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (FrameworkAudit item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListFrameworkAuditsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (FrameworkAudit item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<FrameworkAudit> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (FrameworkAudit item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListFrameworkAudits(OrganizationLocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> ListFrameworkAudits(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
parent OrganizationLocationName

Required. The parent resource where the framework audits are listed.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListFrameworkAuditsResponseFrameworkAudit

A pageable sequence of FrameworkAudit resources.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> response = auditClient.ListFrameworkAudits(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (FrameworkAudit item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListFrameworkAuditsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (FrameworkAudit item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<FrameworkAudit> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (FrameworkAudit item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListFrameworkAudits(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> ListFrameworkAudits(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
parent string

Required. The parent resource where the framework audits are listed.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListFrameworkAuditsResponseFrameworkAudit

A pageable sequence of FrameworkAudit resources.
Example 
// Create client
AuditClient auditClient = AuditClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> response = auditClient.ListFrameworkAudits(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (FrameworkAudit item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListFrameworkAuditsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (FrameworkAudit item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<FrameworkAudit> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (FrameworkAudit item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListFrameworkAuditsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> ListFrameworkAuditsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
parent LocationName

Required. The parent resource where the framework audits are listed.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListFrameworkAuditsResponseFrameworkAudit

A pageable asynchronous sequence of FrameworkAudit resources.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> response = auditClient.ListFrameworkAuditsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((FrameworkAudit item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListFrameworkAuditsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (FrameworkAudit item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<FrameworkAudit> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (FrameworkAudit item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListFrameworkAuditsAsync(ListFrameworkAuditsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> ListFrameworkAuditsAsync(ListFrameworkAuditsRequest request, CallSettings callSettings = null)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
request ListFrameworkAuditsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListFrameworkAuditsResponseFrameworkAudit

A pageable asynchronous sequence of FrameworkAudit resources.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
ListFrameworkAuditsRequest request = new ListFrameworkAuditsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> response = auditClient.ListFrameworkAuditsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((FrameworkAudit item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListFrameworkAuditsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (FrameworkAudit item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<FrameworkAudit> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (FrameworkAudit item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListFrameworkAuditsAsync(OrganizationLocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> ListFrameworkAuditsAsync(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
parent OrganizationLocationName

Required. The parent resource where the framework audits are listed.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListFrameworkAuditsResponseFrameworkAudit

A pageable asynchronous sequence of FrameworkAudit resources.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> response = auditClient.ListFrameworkAuditsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((FrameworkAudit item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListFrameworkAuditsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (FrameworkAudit item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<FrameworkAudit> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (FrameworkAudit item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListFrameworkAuditsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> ListFrameworkAuditsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists the framework audits for a given organization, folder, or project.

Parameters
Name Description
parent string

Required. The parent resource where the framework audits are listed.

Supported formats are the following:

  • organizations/{organization_id}/locations/{location}
  • folders/{folder_id}/locations/{location}
  • projects/{project_id}/locations/{location}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListFrameworkAuditsResponseFrameworkAudit

A pageable asynchronous sequence of FrameworkAudit resources.
Example 
// Create client
AuditClient auditClient = await AuditClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListFrameworkAuditsResponse, FrameworkAudit> response = auditClient.ListFrameworkAuditsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((FrameworkAudit item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListFrameworkAuditsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (FrameworkAudit item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<FrameworkAudit> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (FrameworkAudit item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateFrameworkAudit(string, CallSettings)

public virtual Operation<FrameworkAudit, OperationMetadata> PollOnceCreateFrameworkAudit(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateFrameworkAudit .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationFrameworkAuditOperationMetadata

The result of polling the operation.

PollOnceCreateFrameworkAuditAsync(string, CallSettings)

public virtual Task<Operation<FrameworkAudit, OperationMetadata>> PollOnceCreateFrameworkAuditAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateFrameworkAudit.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationFrameworkAuditOperationMetadata

A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.
Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.