Compute Engine v1 API - Class ResourcePoliciesClient (2.8.0)

public abstract class ResourcePoliciesClient

Reference documentation and code samples for the Compute Engine v1 API class ResourcePoliciesClient.

ResourcePolicies client wrapper, for convenient use.

Inheritance

object > ResourcePoliciesClient

Namespace

GoogleCloudGoogle.Cloud.ComputeV1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The ResourcePolicies API.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
TypeDescription
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ResourcePolicies scopes.

Property Value
TypeDescription
IReadOnlyListstring
Remarks

DeleteOperationsClient

public virtual OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
TypeDescription
OperationsClient

GrpcClient

public virtual ResourcePolicies.ResourcePoliciesClient GrpcClient { get; }

The underlying gRPC ResourcePolicies client

Property Value
TypeDescription
ResourcePoliciesResourcePoliciesClient

InsertOperationsClient

public virtual OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
TypeDescription
OperationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
TypeDescription
ServiceMetadata

Methods

AggregatedList(AggregatedListResourcePoliciesRequest, CallSettings)

public virtual PagedEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> AggregatedList(AggregatedListResourcePoliciesRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of resource policies.

Parameters
NameDescription
requestAggregatedListResourcePoliciesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableResourcePolicyAggregatedListKeyValuePairstringResourcePoliciesScopedList

A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
AggregatedListResourcePoliciesRequest request = new AggregatedListResourcePoliciesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> response = resourcePoliciesClient.AggregatedList(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, ResourcePoliciesScopedList> 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 (ResourcePolicyAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, ResourcePoliciesScopedList> 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<KeyValuePair<string, ResourcePoliciesScopedList>> 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 (KeyValuePair<string, ResourcePoliciesScopedList> 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;

AggregatedList(string, string, int?, CallSettings)

public virtual PagedEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> AggregatedList(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves an aggregated list of resource policies.

Parameters
NameDescription
projectstring

Project ID for this request.

pageTokenstring

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

pageSizeint

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableResourcePolicyAggregatedListKeyValuePairstringResourcePoliciesScopedList

A pageable sequence of KeyValuePair<TKey,TValue> resources.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
string project = "";
// Make the request
PagedEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> response = resourcePoliciesClient.AggregatedList(project);

// Iterate over all response items, lazily performing RPCs as required
foreach (KeyValuePair<string, ResourcePoliciesScopedList> 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 (ResourcePolicyAggregatedList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, ResourcePoliciesScopedList> 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<KeyValuePair<string, ResourcePoliciesScopedList>> 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 (KeyValuePair<string, ResourcePoliciesScopedList> 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;

AggregatedListAsync(AggregatedListResourcePoliciesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> AggregatedListAsync(AggregatedListResourcePoliciesRequest request, CallSettings callSettings = null)

Retrieves an aggregated list of resource policies.

Parameters
NameDescription
requestAggregatedListResourcePoliciesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableResourcePolicyAggregatedListKeyValuePairstringResourcePoliciesScopedList

A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
AggregatedListResourcePoliciesRequest request = new AggregatedListResourcePoliciesRequest
{
    OrderBy = "",
    Project = "",
    Filter = "",
    IncludeAllScopes = false,
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> response = resourcePoliciesClient.AggregatedListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, ResourcePoliciesScopedList> 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((ResourcePolicyAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, ResourcePoliciesScopedList> 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<KeyValuePair<string, ResourcePoliciesScopedList>> 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 (KeyValuePair<string, ResourcePoliciesScopedList> 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;

AggregatedListAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> AggregatedListAsync(string project, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Retrieves an aggregated list of resource policies.

Parameters
NameDescription
projectstring

Project ID for this request.

pageTokenstring

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

pageSizeint

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableResourcePolicyAggregatedListKeyValuePairstringResourcePoliciesScopedList

A pageable asynchronous sequence of KeyValuePair<TKey,TValue> resources.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
// Make the request
PagedAsyncEnumerable<ResourcePolicyAggregatedList, KeyValuePair<string, ResourcePoliciesScopedList>> response = resourcePoliciesClient.AggregatedListAsync(project);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((KeyValuePair<string, ResourcePoliciesScopedList> 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((ResourcePolicyAggregatedList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (KeyValuePair<string, ResourcePoliciesScopedList> 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<KeyValuePair<string, ResourcePoliciesScopedList>> 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 (KeyValuePair<string, ResourcePoliciesScopedList> 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;

Create()

public static ResourcePoliciesClient Create()

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

Returns
TypeDescription
ResourcePoliciesClient

The created ResourcePoliciesClient.

CreateAsync(CancellationToken)

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

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

Parameter
NameDescription
cancellationTokenCancellationToken

The CancellationToken to use while creating the client.

Returns
TypeDescription
TaskResourcePoliciesClient

The task representing the created ResourcePoliciesClient.

Delete(DeleteResourcePolicyRequest, CallSettings)

public virtual Operation<Operation, Operation> Delete(DeleteResourcePolicyRequest request, CallSettings callSettings = null)

Deletes the specified resource policy.

Parameters
NameDescription
requestDeleteResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
DeleteResourcePolicyRequest request = new DeleteResourcePolicyRequest
{
    RequestId = "",
    Region = "",
    ResourcePolicy = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = resourcePoliciesClient.Delete(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = resourcePoliciesClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Delete(string, string, string, CallSettings)

public virtual Operation<Operation, Operation> Delete(string project, string region, string resourcePolicy, CallSettings callSettings = null)

Deletes the specified resource policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

resourcePolicystring

Name of the resource policy to delete.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resourcePolicy = "";
// Make the request
lro::Operation<Operation, Operation> response = resourcePoliciesClient.Delete(project, region, resourcePolicy);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = resourcePoliciesClient.PollOnceDelete(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteResourcePolicyRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteResourcePolicyRequest request, CallSettings callSettings = null)

Deletes the specified resource policy.

Parameters
NameDescription
requestDeleteResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
DeleteResourcePolicyRequest request = new DeleteResourcePolicyRequest
{
    RequestId = "",
    Region = "",
    ResourcePolicy = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await resourcePoliciesClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await resourcePoliciesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(DeleteResourcePolicyRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(DeleteResourcePolicyRequest request, CancellationToken cancellationToken)

Deletes the specified resource policy.

Parameters
NameDescription
requestDeleteResourcePolicyRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
DeleteResourcePolicyRequest request = new DeleteResourcePolicyRequest
{
    RequestId = "",
    Region = "",
    ResourcePolicy = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await resourcePoliciesClient.DeleteAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await resourcePoliciesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(string, string, string, CallSettings)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string resourcePolicy, CallSettings callSettings = null)

Deletes the specified resource policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

resourcePolicystring

Name of the resource policy to delete.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resourcePolicy = "";
// Make the request
lro::Operation<Operation, Operation> response = await resourcePoliciesClient.DeleteAsync(project, region, resourcePolicy);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await resourcePoliciesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

DeleteAsync(string, string, string, CancellationToken)

public virtual Task<Operation<Operation, Operation>> DeleteAsync(string project, string region, string resourcePolicy, CancellationToken cancellationToken)

Deletes the specified resource policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

resourcePolicystring

Name of the resource policy to delete.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resourcePolicy = "";
// Make the request
lro::Operation<Operation, Operation> response = await resourcePoliciesClient.DeleteAsync(project, region, resourcePolicy);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await resourcePoliciesClient.PollOnceDeleteAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Get(GetResourcePolicyRequest, CallSettings)

public virtual ResourcePolicy Get(GetResourcePolicyRequest request, CallSettings callSettings = null)

Retrieves all information of the specified resource policy.

Parameters
NameDescription
requestGetResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ResourcePolicy

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
GetResourcePolicyRequest request = new GetResourcePolicyRequest
{
    Region = "",
    ResourcePolicy = "",
    Project = "",
};
// Make the request
ResourcePolicy response = resourcePoliciesClient.Get(request);

Get(string, string, string, CallSettings)

public virtual ResourcePolicy Get(string project, string region, string resourcePolicy, CallSettings callSettings = null)

Retrieves all information of the specified resource policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

resourcePolicystring

Name of the resource policy to retrieve.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ResourcePolicy

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resourcePolicy = "";
// Make the request
ResourcePolicy response = resourcePoliciesClient.Get(project, region, resourcePolicy);

GetAsync(GetResourcePolicyRequest, CallSettings)

public virtual Task<ResourcePolicy> GetAsync(GetResourcePolicyRequest request, CallSettings callSettings = null)

Retrieves all information of the specified resource policy.

Parameters
NameDescription
requestGetResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskResourcePolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
GetResourcePolicyRequest request = new GetResourcePolicyRequest
{
    Region = "",
    ResourcePolicy = "",
    Project = "",
};
// Make the request
ResourcePolicy response = await resourcePoliciesClient.GetAsync(request);

GetAsync(GetResourcePolicyRequest, CancellationToken)

public virtual Task<ResourcePolicy> GetAsync(GetResourcePolicyRequest request, CancellationToken cancellationToken)

Retrieves all information of the specified resource policy.

Parameters
NameDescription
requestGetResourcePolicyRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskResourcePolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
GetResourcePolicyRequest request = new GetResourcePolicyRequest
{
    Region = "",
    ResourcePolicy = "",
    Project = "",
};
// Make the request
ResourcePolicy response = await resourcePoliciesClient.GetAsync(request);

GetAsync(string, string, string, CallSettings)

public virtual Task<ResourcePolicy> GetAsync(string project, string region, string resourcePolicy, CallSettings callSettings = null)

Retrieves all information of the specified resource policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

resourcePolicystring

Name of the resource policy to retrieve.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskResourcePolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resourcePolicy = "";
// Make the request
ResourcePolicy response = await resourcePoliciesClient.GetAsync(project, region, resourcePolicy);

GetAsync(string, string, string, CancellationToken)

public virtual Task<ResourcePolicy> GetAsync(string project, string region, string resourcePolicy, CancellationToken cancellationToken)

Retrieves all information of the specified resource policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

resourcePolicystring

Name of the resource policy to retrieve.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskResourcePolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resourcePolicy = "";
// Make the request
ResourcePolicy response = await resourcePoliciesClient.GetAsync(project, region, resourcePolicy);

GetIamPolicy(GetIamPolicyResourcePolicyRequest, CallSettings)

public virtual Policy GetIamPolicy(GetIamPolicyResourcePolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
GetIamPolicyResourcePolicyRequest request = new GetIamPolicyResourcePolicyRequest
{
    Region = "",
    Resource = "",
    Project = "",
    OptionsRequestedPolicyVersion = 0,
};
// Make the request
Policy response = resourcePoliciesClient.GetIamPolicy(request);

GetIamPolicy(string, string, string, CallSettings)

public virtual Policy GetIamPolicy(string project, string region, string resource, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region for this request.

resourcestring

Name or id of the resource for this request.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
// Make the request
Policy response = resourcePoliciesClient.GetIamPolicy(project, region, resource);

GetIamPolicyAsync(GetIamPolicyResourcePolicyRequest, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyResourcePolicyRequest request, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyResourcePolicyRequest request = new GetIamPolicyResourcePolicyRequest
{
    Region = "",
    Resource = "",
    Project = "",
    OptionsRequestedPolicyVersion = 0,
};
// Make the request
Policy response = await resourcePoliciesClient.GetIamPolicyAsync(request);

GetIamPolicyAsync(GetIamPolicyResourcePolicyRequest, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(GetIamPolicyResourcePolicyRequest request, CancellationToken cancellationToken)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
requestGetIamPolicyResourcePolicyRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
GetIamPolicyResourcePolicyRequest request = new GetIamPolicyResourcePolicyRequest
{
    Region = "",
    Resource = "",
    Project = "",
    OptionsRequestedPolicyVersion = 0,
};
// Make the request
Policy response = await resourcePoliciesClient.GetIamPolicyAsync(request);

GetIamPolicyAsync(string, string, string, CallSettings)

public virtual Task<Policy> GetIamPolicyAsync(string project, string region, string resource, CallSettings callSettings = null)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region for this request.

resourcestring

Name or id of the resource for this request.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
// Make the request
Policy response = await resourcePoliciesClient.GetIamPolicyAsync(project, region, resource);

GetIamPolicyAsync(string, string, string, CancellationToken)

public virtual Task<Policy> GetIamPolicyAsync(string project, string region, string resource, CancellationToken cancellationToken)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region for this request.

resourcestring

Name or id of the resource for this request.

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
// Make the request
Policy response = await resourcePoliciesClient.GetIamPolicyAsync(project, region, resource);

Insert(InsertResourcePolicyRequest, CallSettings)

public virtual Operation<Operation, Operation> Insert(InsertResourcePolicyRequest request, CallSettings callSettings = null)

Creates a new resource policy.

Parameters
NameDescription
requestInsertResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
InsertResourcePolicyRequest request = new InsertResourcePolicyRequest
{
    RequestId = "",
    ResourcePolicyResource = new ResourcePolicy(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = resourcePoliciesClient.Insert(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = resourcePoliciesClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

Insert(string, string, ResourcePolicy, CallSettings)

public virtual Operation<Operation, Operation> Insert(string project, string region, ResourcePolicy resourcePolicyResource, CallSettings callSettings = null)

Creates a new resource policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

resourcePolicyResourceResourcePolicy

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
ResourcePolicy resourcePolicyResource = new ResourcePolicy();
// Make the request
lro::Operation<Operation, Operation> response = resourcePoliciesClient.Insert(project, region, resourcePolicyResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = resourcePoliciesClient.PollOnceInsert(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertResourcePolicyRequest, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertResourcePolicyRequest request, CallSettings callSettings = null)

Creates a new resource policy.

Parameters
NameDescription
requestInsertResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
InsertResourcePolicyRequest request = new InsertResourcePolicyRequest
{
    RequestId = "",
    ResourcePolicyResource = new ResourcePolicy(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await resourcePoliciesClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await resourcePoliciesClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(InsertResourcePolicyRequest, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(InsertResourcePolicyRequest request, CancellationToken cancellationToken)

Creates a new resource policy.

Parameters
NameDescription
requestInsertResourcePolicyRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
InsertResourcePolicyRequest request = new InsertResourcePolicyRequest
{
    RequestId = "",
    ResourcePolicyResource = new ResourcePolicy(),
    Region = "",
    Project = "",
};
// Make the request
lro::Operation<Operation, Operation> response = await resourcePoliciesClient.InsertAsync(request);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await resourcePoliciesClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(string, string, ResourcePolicy, CallSettings)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, ResourcePolicy resourcePolicyResource, CallSettings callSettings = null)

Creates a new resource policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

resourcePolicyResourceResourcePolicy

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
ResourcePolicy resourcePolicyResource = new ResourcePolicy();
// Make the request
lro::Operation<Operation, Operation> response = await resourcePoliciesClient.InsertAsync(project, region, resourcePolicyResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await resourcePoliciesClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

InsertAsync(string, string, ResourcePolicy, CancellationToken)

public virtual Task<Operation<Operation, Operation>> InsertAsync(string project, string region, ResourcePolicy resourcePolicyResource, CancellationToken cancellationToken)

Creates a new resource policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

resourcePolicyResourceResourcePolicy

The body resource for this request

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskOperationOperationOperation

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
ResourcePolicy resourcePolicyResource = new ResourcePolicy();
// Make the request
lro::Operation<Operation, Operation> response = await resourcePoliciesClient.InsertAsync(project, region, resourcePolicyResource);

// Poll until the returned long-running operation is complete
lro::Operation<Operation, Operation> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Operation 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
lro::Operation<Operation, Operation> retrievedResponse = await resourcePoliciesClient.PollOnceInsertAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Operation retrievedResult = retrievedResponse.Result;
}

List(ListResourcePoliciesRequest, CallSettings)

public virtual PagedEnumerable<ResourcePolicyList, ResourcePolicy> List(ListResourcePoliciesRequest request, CallSettings callSettings = null)

A list all the resource policies that have been configured for the specified project in specified region.

Parameters
NameDescription
requestListResourcePoliciesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableResourcePolicyListResourcePolicy

A pageable sequence of ResourcePolicy resources.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
ListResourcePoliciesRequest request = new ListResourcePoliciesRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedEnumerable<ResourcePolicyList, ResourcePolicy> response = resourcePoliciesClient.List(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (ResourcePolicy 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 (ResourcePolicyList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResourcePolicy 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<ResourcePolicy> 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 (ResourcePolicy 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;

List(string, string, string, int?, CallSettings)

public virtual PagedEnumerable<ResourcePolicyList, ResourcePolicy> List(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

A list all the resource policies that have been configured for the specified project in specified region.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

pageTokenstring

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

pageSizeint

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableResourcePolicyListResourcePolicy

A pageable sequence of ResourcePolicy resources.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedEnumerable<ResourcePolicyList, ResourcePolicy> response = resourcePoliciesClient.List(project, region);

// Iterate over all response items, lazily performing RPCs as required
foreach (ResourcePolicy 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 (ResourcePolicyList page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResourcePolicy 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<ResourcePolicy> 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 (ResourcePolicy 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;

ListAsync(ListResourcePoliciesRequest, CallSettings)

public virtual PagedAsyncEnumerable<ResourcePolicyList, ResourcePolicy> ListAsync(ListResourcePoliciesRequest request, CallSettings callSettings = null)

A list all the resource policies that have been configured for the specified project in specified region.

Parameters
NameDescription
requestListResourcePoliciesRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableResourcePolicyListResourcePolicy

A pageable asynchronous sequence of ResourcePolicy resources.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
ListResourcePoliciesRequest request = new ListResourcePoliciesRequest
{
    Region = "",
    OrderBy = "",
    Project = "",
    Filter = "",
    ReturnPartialSuccess = false,
};
// Make the request
PagedAsyncEnumerable<ResourcePolicyList, ResourcePolicy> response = resourcePoliciesClient.ListAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ResourcePolicy 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((ResourcePolicyList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResourcePolicy 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<ResourcePolicy> 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 (ResourcePolicy 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;

ListAsync(string, string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ResourcePolicyList, ResourcePolicy> ListAsync(string project, string region, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

A list all the resource policies that have been configured for the specified project in specified region.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

Name of the region for this request.

pageTokenstring

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

pageSizeint

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.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableResourcePolicyListResourcePolicy

A pageable asynchronous sequence of ResourcePolicy resources.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
// Make the request
PagedAsyncEnumerable<ResourcePolicyList, ResourcePolicy> response = resourcePoliciesClient.ListAsync(project, region);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((ResourcePolicy 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((ResourcePolicyList page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (ResourcePolicy 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<ResourcePolicy> 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 (ResourcePolicy 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;

PollOnceDelete(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceDelete(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The result of polling the operation.

PollOnceDeleteAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceDeleteAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A task representing the result of polling the operation.

PollOnceInsert(string, CallSettings)

public virtual Operation<Operation, Operation> PollOnceInsert(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationOperationOperation

The result of polling the operation.

PollOnceInsertAsync(string, CallSettings)

public virtual Task<Operation<Operation, Operation>> PollOnceInsertAsync(string operationName, CallSettings callSettings = null)

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

Parameters
NameDescription
operationNamestring

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationOperationOperation

A task representing the result of polling the operation.

SetIamPolicy(SetIamPolicyResourcePolicyRequest, CallSettings)

public virtual Policy SetIamPolicy(SetIamPolicyResourcePolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
SetIamPolicyResourcePolicyRequest request = new SetIamPolicyResourcePolicyRequest
{
    Region = "",
    Resource = "",
    Project = "",
    RegionSetPolicyRequestResource = new RegionSetPolicyRequest(),
};
// Make the request
Policy response = resourcePoliciesClient.SetIamPolicy(request);

SetIamPolicy(string, string, string, RegionSetPolicyRequest, CallSettings)

public virtual Policy SetIamPolicy(string project, string region, string resource, RegionSetPolicyRequest regionSetPolicyRequestResource, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region for this request.

resourcestring

Name or id of the resource for this request.

regionSetPolicyRequestResourceRegionSetPolicyRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Policy

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetPolicyRequest regionSetPolicyRequestResource = new RegionSetPolicyRequest();
// Make the request
Policy response = resourcePoliciesClient.SetIamPolicy(project, region, resource, regionSetPolicyRequestResource);

SetIamPolicyAsync(SetIamPolicyResourcePolicyRequest, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyResourcePolicyRequest request, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyResourcePolicyRequest request = new SetIamPolicyResourcePolicyRequest
{
    Region = "",
    Resource = "",
    Project = "",
    RegionSetPolicyRequestResource = new RegionSetPolicyRequest(),
};
// Make the request
Policy response = await resourcePoliciesClient.SetIamPolicyAsync(request);

SetIamPolicyAsync(SetIamPolicyResourcePolicyRequest, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(SetIamPolicyResourcePolicyRequest request, CancellationToken cancellationToken)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
requestSetIamPolicyResourcePolicyRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
SetIamPolicyResourcePolicyRequest request = new SetIamPolicyResourcePolicyRequest
{
    Region = "",
    Resource = "",
    Project = "",
    RegionSetPolicyRequestResource = new RegionSetPolicyRequest(),
};
// Make the request
Policy response = await resourcePoliciesClient.SetIamPolicyAsync(request);

SetIamPolicyAsync(string, string, string, RegionSetPolicyRequest, CallSettings)

public virtual Task<Policy> SetIamPolicyAsync(string project, string region, string resource, RegionSetPolicyRequest regionSetPolicyRequestResource, CallSettings callSettings = null)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region for this request.

resourcestring

Name or id of the resource for this request.

regionSetPolicyRequestResourceRegionSetPolicyRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetPolicyRequest regionSetPolicyRequestResource = new RegionSetPolicyRequest();
// Make the request
Policy response = await resourcePoliciesClient.SetIamPolicyAsync(project, region, resource, regionSetPolicyRequestResource);

SetIamPolicyAsync(string, string, string, RegionSetPolicyRequest, CancellationToken)

public virtual Task<Policy> SetIamPolicyAsync(string project, string region, string resource, RegionSetPolicyRequest regionSetPolicyRequestResource, CancellationToken cancellationToken)

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region for this request.

resourcestring

Name or id of the resource for this request.

regionSetPolicyRequestResourceRegionSetPolicyRequest

The body resource for this request

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskPolicy

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
RegionSetPolicyRequest regionSetPolicyRequestResource = new RegionSetPolicyRequest();
// Make the request
Policy response = await resourcePoliciesClient.SetIamPolicyAsync(project, region, resource, regionSetPolicyRequestResource);

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

TestIamPermissions(TestIamPermissionsResourcePolicyRequest, CallSettings)

public virtual TestPermissionsResponse TestIamPermissions(TestIamPermissionsResourcePolicyRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestPermissionsResponse

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
TestIamPermissionsResourcePolicyRequest request = new TestIamPermissionsResourcePolicyRequest
{
    Region = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = resourcePoliciesClient.TestIamPermissions(request);

TestIamPermissions(string, string, string, TestPermissionsRequest, CallSettings)

public virtual TestPermissionsResponse TestIamPermissions(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region for this request.

resourcestring

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TestPermissionsResponse

The RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = ResourcePoliciesClient.Create();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = resourcePoliciesClient.TestIamPermissions(project, region, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest, CallSettings)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest request, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsResourcePolicyRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTestPermissionsResponse

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsResourcePolicyRequest request = new TestIamPermissionsResourcePolicyRequest
{
    Region = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await resourcePoliciesClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest, CancellationToken)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsResourcePolicyRequest request, CancellationToken cancellationToken)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
requestTestIamPermissionsResourcePolicyRequest

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

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTestPermissionsResponse

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
TestIamPermissionsResourcePolicyRequest request = new TestIamPermissionsResourcePolicyRequest
{
    Region = "",
    Resource = "",
    Project = "",
    TestPermissionsRequestResource = new TestPermissionsRequest(),
};
// Make the request
TestPermissionsResponse response = await resourcePoliciesClient.TestIamPermissionsAsync(request);

TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CallSettings)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CallSettings callSettings = null)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region for this request.

resourcestring

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskTestPermissionsResponse

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await resourcePoliciesClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);

TestIamPermissionsAsync(string, string, string, TestPermissionsRequest, CancellationToken)

public virtual Task<TestPermissionsResponse> TestIamPermissionsAsync(string project, string region, string resource, TestPermissionsRequest testPermissionsRequestResource, CancellationToken cancellationToken)

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
projectstring

Project ID for this request.

regionstring

The name of the region for this request.

resourcestring

Name or id of the resource for this request.

testPermissionsRequestResourceTestPermissionsRequest

The body resource for this request

cancellationTokenCancellationToken

A CancellationToken to use for this RPC.

Returns
TypeDescription
TaskTestPermissionsResponse

A Task containing the RPC response.

Example
// Create client
ResourcePoliciesClient resourcePoliciesClient = await ResourcePoliciesClient.CreateAsync();
// Initialize request argument(s)
string project = "";
string region = "";
string resource = "";
TestPermissionsRequest testPermissionsRequestResource = new TestPermissionsRequest();
// Make the request
TestPermissionsResponse response = await resourcePoliciesClient.TestIamPermissionsAsync(project, region, resource, testPermissionsRequestResource);