public abstract class ConfigClient
Reference documentation and code samples for the Cloud Security Compliance v1 API class ConfigClient.
Config client wrapper, for convenient use.
Derived Types
Namespace
Google.Cloud.CloudSecurityCompliance.V1Assembly
Google.Cloud.CloudSecurityCompliance.V1.dll
Remarks
Config Service manages compliance frameworks, cloud controls, and their configurations.
Properties
DefaultEndpoint
public static string DefaultEndpoint { get; }
The default endpoint for the Config 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 Config scopes.
Property Value | |
---|---|
Type | Description |
IReadOnlyListstring |
The default Config scopes are:
GrpcClient
public virtual Config.ConfigClient GrpcClient { get; }
The underlying gRPC Config client
Property Value | |
---|---|
Type | Description |
ConfigConfigClient |
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 ConfigClient Create()
Synchronously creates a ConfigClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ConfigClientBuilder.
Returns | |
---|---|
Type | Description |
ConfigClient |
The created ConfigClient. |
CreateAsync(CancellationToken)
public static Task<ConfigClient> CreateAsync(CancellationToken cancellationToken = default)
Asynchronously creates a ConfigClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ConfigClientBuilder.
Parameter | |
---|---|
Name | Description |
cancellationToken |
CancellationToken The CancellationToken to use while creating the client. |
Returns | |
---|---|
Type | Description |
TaskConfigClient |
The task representing the created ConfigClient. |
CreateCloudControl(CreateCloudControlRequest, CallSettings)
public virtual CloudControl CreateCloudControl(CreateCloudControlRequest request, CallSettings callSettings = null)
Creates a new CloudControl with type Custom
under a given parent
resource. Built-in
CloudControls are managed by Google and cannot be
created through this API.
Parameters | |
---|---|
Name | Description |
request |
CreateCloudControlRequest 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 |
CloudControl |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
CreateCloudControlRequest request = new CreateCloudControlRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
CloudControlId = "",
CloudControl = new CloudControl(),
};
// Make the request
CloudControl response = configClient.CreateCloudControl(request);
CreateCloudControl(OrganizationLocationName, CloudControl, string, CallSettings)
public virtual CloudControl CreateCloudControl(OrganizationLocationName parent, CloudControl cloudControl, string cloudControlId, CallSettings callSettings = null)
Creates a new CloudControl with type Custom
under a given parent
resource. Built-in
CloudControls are managed by Google and cannot be
created through this API.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
cloudControl |
CloudControl Required. The resource being created |
cloudControlId |
string Required. ID of the CloudControl.
This is the last segment of the CloudControl resource name.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
CloudControl |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
CloudControl cloudControl = new CloudControl();
string cloudControlId = "";
// Make the request
CloudControl response = configClient.CreateCloudControl(parent, cloudControl, cloudControlId);
CreateCloudControl(string, CloudControl, string, CallSettings)
public virtual CloudControl CreateCloudControl(string parent, CloudControl cloudControl, string cloudControlId, CallSettings callSettings = null)
Creates a new CloudControl with type Custom
under a given parent
resource. Built-in
CloudControls are managed by Google and cannot be
created through this API.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
cloudControl |
CloudControl Required. The resource being created |
cloudControlId |
string Required. ID of the CloudControl.
This is the last segment of the CloudControl resource name.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
CloudControl |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
CloudControl cloudControl = new CloudControl();
string cloudControlId = "";
// Make the request
CloudControl response = configClient.CreateCloudControl(parent, cloudControl, cloudControlId);
CreateCloudControlAsync(CreateCloudControlRequest, CallSettings)
public virtual Task<CloudControl> CreateCloudControlAsync(CreateCloudControlRequest request, CallSettings callSettings = null)
Creates a new CloudControl with type Custom
under a given parent
resource. Built-in
CloudControls are managed by Google and cannot be
created through this API.
Parameters | |
---|---|
Name | Description |
request |
CreateCloudControlRequest 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 |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CreateCloudControlRequest request = new CreateCloudControlRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
CloudControlId = "",
CloudControl = new CloudControl(),
};
// Make the request
CloudControl response = await configClient.CreateCloudControlAsync(request);
CreateCloudControlAsync(CreateCloudControlRequest, CancellationToken)
public virtual Task<CloudControl> CreateCloudControlAsync(CreateCloudControlRequest request, CancellationToken cancellationToken)
Creates a new CloudControl with type Custom
under a given parent
resource. Built-in
CloudControls are managed by Google and cannot be
created through this API.
Parameters | |
---|---|
Name | Description |
request |
CreateCloudControlRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CreateCloudControlRequest request = new CreateCloudControlRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
CloudControlId = "",
CloudControl = new CloudControl(),
};
// Make the request
CloudControl response = await configClient.CreateCloudControlAsync(request);
CreateCloudControlAsync(OrganizationLocationName, CloudControl, string, CallSettings)
public virtual Task<CloudControl> CreateCloudControlAsync(OrganizationLocationName parent, CloudControl cloudControl, string cloudControlId, CallSettings callSettings = null)
Creates a new CloudControl with type Custom
under a given parent
resource. Built-in
CloudControls are managed by Google and cannot be
created through this API.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
cloudControl |
CloudControl Required. The resource being created |
cloudControlId |
string Required. ID of the CloudControl.
This is the last segment of the CloudControl resource name.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
CloudControl cloudControl = new CloudControl();
string cloudControlId = "";
// Make the request
CloudControl response = await configClient.CreateCloudControlAsync(parent, cloudControl, cloudControlId);
CreateCloudControlAsync(OrganizationLocationName, CloudControl, string, CancellationToken)
public virtual Task<CloudControl> CreateCloudControlAsync(OrganizationLocationName parent, CloudControl cloudControl, string cloudControlId, CancellationToken cancellationToken)
Creates a new CloudControl with type Custom
under a given parent
resource. Built-in
CloudControls are managed by Google and cannot be
created through this API.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
cloudControl |
CloudControl Required. The resource being created |
cloudControlId |
string Required. ID of the CloudControl.
This is the last segment of the CloudControl resource name.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
CloudControl cloudControl = new CloudControl();
string cloudControlId = "";
// Make the request
CloudControl response = await configClient.CreateCloudControlAsync(parent, cloudControl, cloudControlId);
CreateCloudControlAsync(string, CloudControl, string, CallSettings)
public virtual Task<CloudControl> CreateCloudControlAsync(string parent, CloudControl cloudControl, string cloudControlId, CallSettings callSettings = null)
Creates a new CloudControl with type Custom
under a given parent
resource. Built-in
CloudControls are managed by Google and cannot be
created through this API.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
cloudControl |
CloudControl Required. The resource being created |
cloudControlId |
string Required. ID of the CloudControl.
This is the last segment of the CloudControl resource name.
Format: |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
CloudControl cloudControl = new CloudControl();
string cloudControlId = "";
// Make the request
CloudControl response = await configClient.CreateCloudControlAsync(parent, cloudControl, cloudControlId);
CreateCloudControlAsync(string, CloudControl, string, CancellationToken)
public virtual Task<CloudControl> CreateCloudControlAsync(string parent, CloudControl cloudControl, string cloudControlId, CancellationToken cancellationToken)
Creates a new CloudControl with type Custom
under a given parent
resource. Built-in
CloudControls are managed by Google and cannot be
created through this API.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
cloudControl |
CloudControl Required. The resource being created |
cloudControlId |
string Required. ID of the CloudControl.
This is the last segment of the CloudControl resource name.
Format: |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
CloudControl cloudControl = new CloudControl();
string cloudControlId = "";
// Make the request
CloudControl response = await configClient.CreateCloudControlAsync(parent, cloudControl, cloudControlId);
CreateFramework(CreateFrameworkRequest, CallSettings)
public virtual Framework CreateFramework(CreateFrameworkRequest request, CallSettings callSettings = null)
Creates a new Framework with type Custom
under a given parent resource.
Frameworks with type Built-in
are managed by Google and cannot be created
through this API.
Parameters | |
---|---|
Name | Description |
request |
CreateFrameworkRequest 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 |
Framework |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
CreateFrameworkRequest request = new CreateFrameworkRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
FrameworkId = "",
Framework = new Framework(),
};
// Make the request
Framework response = configClient.CreateFramework(request);
CreateFramework(OrganizationLocationName, Framework, string, CallSettings)
public virtual Framework CreateFramework(OrganizationLocationName parent, Framework framework, string frameworkId, CallSettings callSettings = null)
Creates a new Framework with type Custom
under a given parent resource.
Frameworks with type Built-in
are managed by Google and cannot be created
through this API.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
framework |
Framework Required. The resource being created |
frameworkId |
string Required. ID of the framework. This is not the full name of the framework. This is the last part of the full name of the framework. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Framework |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
Framework framework = new Framework();
string frameworkId = "";
// Make the request
Framework response = configClient.CreateFramework(parent, framework, frameworkId);
CreateFramework(string, Framework, string, CallSettings)
public virtual Framework CreateFramework(string parent, Framework framework, string frameworkId, CallSettings callSettings = null)
Creates a new Framework with type Custom
under a given parent resource.
Frameworks with type Built-in
are managed by Google and cannot be created
through this API.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
framework |
Framework Required. The resource being created |
frameworkId |
string Required. ID of the framework. This is not the full name of the framework. This is the last part of the full name of the framework. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Framework |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
Framework framework = new Framework();
string frameworkId = "";
// Make the request
Framework response = configClient.CreateFramework(parent, framework, frameworkId);
CreateFrameworkAsync(CreateFrameworkRequest, CallSettings)
public virtual Task<Framework> CreateFrameworkAsync(CreateFrameworkRequest request, CallSettings callSettings = null)
Creates a new Framework with type Custom
under a given parent resource.
Frameworks with type Built-in
are managed by Google and cannot be created
through this API.
Parameters | |
---|---|
Name | Description |
request |
CreateFrameworkRequest 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 |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CreateFrameworkRequest request = new CreateFrameworkRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
FrameworkId = "",
Framework = new Framework(),
};
// Make the request
Framework response = await configClient.CreateFrameworkAsync(request);
CreateFrameworkAsync(CreateFrameworkRequest, CancellationToken)
public virtual Task<Framework> CreateFrameworkAsync(CreateFrameworkRequest request, CancellationToken cancellationToken)
Creates a new Framework with type Custom
under a given parent resource.
Frameworks with type Built-in
are managed by Google and cannot be created
through this API.
Parameters | |
---|---|
Name | Description |
request |
CreateFrameworkRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CreateFrameworkRequest request = new CreateFrameworkRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
FrameworkId = "",
Framework = new Framework(),
};
// Make the request
Framework response = await configClient.CreateFrameworkAsync(request);
CreateFrameworkAsync(OrganizationLocationName, Framework, string, CallSettings)
public virtual Task<Framework> CreateFrameworkAsync(OrganizationLocationName parent, Framework framework, string frameworkId, CallSettings callSettings = null)
Creates a new Framework with type Custom
under a given parent resource.
Frameworks with type Built-in
are managed by Google and cannot be created
through this API.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
framework |
Framework Required. The resource being created |
frameworkId |
string Required. ID of the framework. This is not the full name of the framework. This is the last part of the full name of the framework. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
Framework framework = new Framework();
string frameworkId = "";
// Make the request
Framework response = await configClient.CreateFrameworkAsync(parent, framework, frameworkId);
CreateFrameworkAsync(OrganizationLocationName, Framework, string, CancellationToken)
public virtual Task<Framework> CreateFrameworkAsync(OrganizationLocationName parent, Framework framework, string frameworkId, CancellationToken cancellationToken)
Creates a new Framework with type Custom
under a given parent resource.
Frameworks with type Built-in
are managed by Google and cannot be created
through this API.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
framework |
Framework Required. The resource being created |
frameworkId |
string Required. ID of the framework. This is not the full name of the framework. This is the last part of the full name of the framework. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
Framework framework = new Framework();
string frameworkId = "";
// Make the request
Framework response = await configClient.CreateFrameworkAsync(parent, framework, frameworkId);
CreateFrameworkAsync(string, Framework, string, CallSettings)
public virtual Task<Framework> CreateFrameworkAsync(string parent, Framework framework, string frameworkId, CallSettings callSettings = null)
Creates a new Framework with type Custom
under a given parent resource.
Frameworks with type Built-in
are managed by Google and cannot be created
through this API.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
framework |
Framework Required. The resource being created |
frameworkId |
string Required. ID of the framework. This is not the full name of the framework. This is the last part of the full name of the framework. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
Framework framework = new Framework();
string frameworkId = "";
// Make the request
Framework response = await configClient.CreateFrameworkAsync(parent, framework, frameworkId);
CreateFrameworkAsync(string, Framework, string, CancellationToken)
public virtual Task<Framework> CreateFrameworkAsync(string parent, Framework framework, string frameworkId, CancellationToken cancellationToken)
Creates a new Framework with type Custom
under a given parent resource.
Frameworks with type Built-in
are managed by Google and cannot be created
through this API.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
framework |
Framework Required. The resource being created |
frameworkId |
string Required. ID of the framework. This is not the full name of the framework. This is the last part of the full name of the framework. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
Framework framework = new Framework();
string frameworkId = "";
// Make the request
Framework response = await configClient.CreateFrameworkAsync(parent, framework, frameworkId);
DeleteCloudControl(CloudControlName, CallSettings)
public virtual void DeleteCloudControl(CloudControlName name, CallSettings callSettings = null)
Deletes a single Custom CloudControl, including all its major and minor revisions.
- This operation can only be performed on CloudControls with type
CUSTOM
. Built-in CloudControls cannot be deleted. - The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
CloudControlName Required. Name of the resource, in the format
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
CloudControlName name = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]");
// Make the request
configClient.DeleteCloudControl(name);
DeleteCloudControl(DeleteCloudControlRequest, CallSettings)
public virtual void DeleteCloudControl(DeleteCloudControlRequest request, CallSettings callSettings = null)
Deletes a single Custom CloudControl, including all its major and minor revisions.
- This operation can only be performed on CloudControls with type
CUSTOM
. Built-in CloudControls cannot be deleted. - The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
request |
DeleteCloudControlRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeleteCloudControlRequest request = new DeleteCloudControlRequest
{
CloudControlName = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]"),
};
// Make the request
configClient.DeleteCloudControl(request);
DeleteCloudControl(string, CallSettings)
public virtual void DeleteCloudControl(string name, CallSettings callSettings = null)
Deletes a single Custom CloudControl, including all its major and minor revisions.
- This operation can only be performed on CloudControls with type
CUSTOM
. Built-in CloudControls cannot be deleted. - The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
string Required. Name of the resource, in the format
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/cloudControls/[CLOUD_CONTROL]";
// Make the request
configClient.DeleteCloudControl(name);
DeleteCloudControlAsync(CloudControlName, CallSettings)
public virtual Task DeleteCloudControlAsync(CloudControlName name, CallSettings callSettings = null)
Deletes a single Custom CloudControl, including all its major and minor revisions.
- This operation can only be performed on CloudControls with type
CUSTOM
. Built-in CloudControls cannot be deleted. - The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
CloudControlName Required. Name of the resource, in the format
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CloudControlName name = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]");
// Make the request
await configClient.DeleteCloudControlAsync(name);
DeleteCloudControlAsync(CloudControlName, CancellationToken)
public virtual Task DeleteCloudControlAsync(CloudControlName name, CancellationToken cancellationToken)
Deletes a single Custom CloudControl, including all its major and minor revisions.
- This operation can only be performed on CloudControls with type
CUSTOM
. Built-in CloudControls cannot be deleted. - The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
CloudControlName Required. Name of the resource, in the format
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CloudControlName name = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]");
// Make the request
await configClient.DeleteCloudControlAsync(name);
DeleteCloudControlAsync(DeleteCloudControlRequest, CallSettings)
public virtual Task DeleteCloudControlAsync(DeleteCloudControlRequest request, CallSettings callSettings = null)
Deletes a single Custom CloudControl, including all its major and minor revisions.
- This operation can only be performed on CloudControls with type
CUSTOM
. Built-in CloudControls cannot be deleted. - The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
request |
DeleteCloudControlRequest 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 |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeleteCloudControlRequest request = new DeleteCloudControlRequest
{
CloudControlName = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]"),
};
// Make the request
await configClient.DeleteCloudControlAsync(request);
DeleteCloudControlAsync(DeleteCloudControlRequest, CancellationToken)
public virtual Task DeleteCloudControlAsync(DeleteCloudControlRequest request, CancellationToken cancellationToken)
Deletes a single Custom CloudControl, including all its major and minor revisions.
- This operation can only be performed on CloudControls with type
CUSTOM
. Built-in CloudControls cannot be deleted. - The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
request |
DeleteCloudControlRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeleteCloudControlRequest request = new DeleteCloudControlRequest
{
CloudControlName = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]"),
};
// Make the request
await configClient.DeleteCloudControlAsync(request);
DeleteCloudControlAsync(string, CallSettings)
public virtual Task DeleteCloudControlAsync(string name, CallSettings callSettings = null)
Deletes a single Custom CloudControl, including all its major and minor revisions.
- This operation can only be performed on CloudControls with type
CUSTOM
. Built-in CloudControls cannot be deleted. - The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
string Required. Name of the resource, in the format
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/cloudControls/[CLOUD_CONTROL]";
// Make the request
await configClient.DeleteCloudControlAsync(name);
DeleteCloudControlAsync(string, CancellationToken)
public virtual Task DeleteCloudControlAsync(string name, CancellationToken cancellationToken)
Deletes a single Custom CloudControl, including all its major and minor revisions.
- This operation can only be performed on CloudControls with type
CUSTOM
. Built-in CloudControls cannot be deleted. - The CloudControl cannot be deleted if any of its revisions are currently referenced by any Framework.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
string Required. Name of the resource, in the format
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/cloudControls/[CLOUD_CONTROL]";
// Make the request
await configClient.DeleteCloudControlAsync(name);
DeleteFramework(DeleteFrameworkRequest, CallSettings)
public virtual void DeleteFramework(DeleteFrameworkRequest request, CallSettings callSettings = null)
Deletes a single Custom Framework, including all its minor and minor revisions.
- This operation can only be performed on Frameworks with type
CUSTOM
. Built-in Frameworks cannot be deleted. - The Framework cannot be deleted if it is currently deployed on any resource.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
request |
DeleteFrameworkRequest The request object containing all of the parameters for the API call. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
DeleteFrameworkRequest request = new DeleteFrameworkRequest
{
FrameworkName = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]"),
};
// Make the request
configClient.DeleteFramework(request);
DeleteFramework(FrameworkName, CallSettings)
public virtual void DeleteFramework(FrameworkName name, CallSettings callSettings = null)
Deletes a single Custom Framework, including all its minor and minor revisions.
- This operation can only be performed on Frameworks with type
CUSTOM
. Built-in Frameworks cannot be deleted. - The Framework cannot be deleted if it is currently deployed on any resource.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
FrameworkName Required. Name of the resource, in the format
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
FrameworkName name = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]");
// Make the request
configClient.DeleteFramework(name);
DeleteFramework(string, CallSettings)
public virtual void DeleteFramework(string name, CallSettings callSettings = null)
Deletes a single Custom Framework, including all its minor and minor revisions.
- This operation can only be performed on Frameworks with type
CUSTOM
. Built-in Frameworks cannot be deleted. - The Framework cannot be deleted if it is currently deployed on any resource.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
string Required. Name of the resource, in the format
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworks/[FRAMEWORK]";
// Make the request
configClient.DeleteFramework(name);
DeleteFrameworkAsync(DeleteFrameworkRequest, CallSettings)
public virtual Task DeleteFrameworkAsync(DeleteFrameworkRequest request, CallSettings callSettings = null)
Deletes a single Custom Framework, including all its minor and minor revisions.
- This operation can only be performed on Frameworks with type
CUSTOM
. Built-in Frameworks cannot be deleted. - The Framework cannot be deleted if it is currently deployed on any resource.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
request |
DeleteFrameworkRequest 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 |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeleteFrameworkRequest request = new DeleteFrameworkRequest
{
FrameworkName = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]"),
};
// Make the request
await configClient.DeleteFrameworkAsync(request);
DeleteFrameworkAsync(DeleteFrameworkRequest, CancellationToken)
public virtual Task DeleteFrameworkAsync(DeleteFrameworkRequest request, CancellationToken cancellationToken)
Deletes a single Custom Framework, including all its minor and minor revisions.
- This operation can only be performed on Frameworks with type
CUSTOM
. Built-in Frameworks cannot be deleted. - The Framework cannot be deleted if it is currently deployed on any resource.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
request |
DeleteFrameworkRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
DeleteFrameworkRequest request = new DeleteFrameworkRequest
{
FrameworkName = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]"),
};
// Make the request
await configClient.DeleteFrameworkAsync(request);
DeleteFrameworkAsync(FrameworkName, CallSettings)
public virtual Task DeleteFrameworkAsync(FrameworkName name, CallSettings callSettings = null)
Deletes a single Custom Framework, including all its minor and minor revisions.
- This operation can only be performed on Frameworks with type
CUSTOM
. Built-in Frameworks cannot be deleted. - The Framework cannot be deleted if it is currently deployed on any resource.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
FrameworkName Required. Name of the resource, in the format
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
FrameworkName name = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]");
// Make the request
await configClient.DeleteFrameworkAsync(name);
DeleteFrameworkAsync(FrameworkName, CancellationToken)
public virtual Task DeleteFrameworkAsync(FrameworkName name, CancellationToken cancellationToken)
Deletes a single Custom Framework, including all its minor and minor revisions.
- This operation can only be performed on Frameworks with type
CUSTOM
. Built-in Frameworks cannot be deleted. - The Framework cannot be deleted if it is currently deployed on any resource.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
FrameworkName Required. Name of the resource, in the format
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
FrameworkName name = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]");
// Make the request
await configClient.DeleteFrameworkAsync(name);
DeleteFrameworkAsync(string, CallSettings)
public virtual Task DeleteFrameworkAsync(string name, CallSettings callSettings = null)
Deletes a single Custom Framework, including all its minor and minor revisions.
- This operation can only be performed on Frameworks with type
CUSTOM
. Built-in Frameworks cannot be deleted. - The Framework cannot be deleted if it is currently deployed on any resource.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
string Required. Name of the resource, in the format
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworks/[FRAMEWORK]";
// Make the request
await configClient.DeleteFrameworkAsync(name);
DeleteFrameworkAsync(string, CancellationToken)
public virtual Task DeleteFrameworkAsync(string name, CancellationToken cancellationToken)
Deletes a single Custom Framework, including all its minor and minor revisions.
- This operation can only be performed on Frameworks with type
CUSTOM
. Built-in Frameworks cannot be deleted. - The Framework cannot be deleted if it is currently deployed on any resource.
- This action is permanent and cannot be undone.
Parameters | |
---|---|
Name | Description |
name |
string Required. Name of the resource, in the format
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
Task |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworks/[FRAMEWORK]";
// Make the request
await configClient.DeleteFrameworkAsync(name);
GetCloudControl(CloudControlName, CallSettings)
public virtual CloudControl GetCloudControl(CloudControlName name, CallSettings callSettings = null)
Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the CloudControl is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
CloudControlName Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control} |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
CloudControl |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
CloudControlName name = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]");
// Make the request
CloudControl response = configClient.GetCloudControl(name);
GetCloudControl(GetCloudControlRequest, CallSettings)
public virtual CloudControl GetCloudControl(GetCloudControlRequest request, CallSettings callSettings = null)
Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the CloudControl is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
request |
GetCloudControlRequest 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 |
CloudControl |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
GetCloudControlRequest request = new GetCloudControlRequest
{
CloudControlName = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]"),
};
// Make the request
CloudControl response = configClient.GetCloudControl(request);
GetCloudControl(string, CallSettings)
public virtual CloudControl GetCloudControl(string name, CallSettings callSettings = null)
Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the CloudControl is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control} |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
CloudControl |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/cloudControls/[CLOUD_CONTROL]";
// Make the request
CloudControl response = configClient.GetCloudControl(name);
GetCloudControlAsync(CloudControlName, CallSettings)
public virtual Task<CloudControl> GetCloudControlAsync(CloudControlName name, CallSettings callSettings = null)
Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the CloudControl is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
CloudControlName Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control} |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CloudControlName name = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]");
// Make the request
CloudControl response = await configClient.GetCloudControlAsync(name);
GetCloudControlAsync(CloudControlName, CancellationToken)
public virtual Task<CloudControl> GetCloudControlAsync(CloudControlName name, CancellationToken cancellationToken)
Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the CloudControl is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
CloudControlName Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control} |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CloudControlName name = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]");
// Make the request
CloudControl response = await configClient.GetCloudControlAsync(name);
GetCloudControlAsync(GetCloudControlRequest, CallSettings)
public virtual Task<CloudControl> GetCloudControlAsync(GetCloudControlRequest request, CallSettings callSettings = null)
Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the CloudControl is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
request |
GetCloudControlRequest 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 |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetCloudControlRequest request = new GetCloudControlRequest
{
CloudControlName = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]"),
};
// Make the request
CloudControl response = await configClient.GetCloudControlAsync(request);
GetCloudControlAsync(GetCloudControlRequest, CancellationToken)
public virtual Task<CloudControl> GetCloudControlAsync(GetCloudControlRequest request, CancellationToken cancellationToken)
Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the CloudControl is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
request |
GetCloudControlRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetCloudControlRequest request = new GetCloudControlRequest
{
CloudControlName = CloudControlName.FromOrganizationLocationCloudControl("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]"),
};
// Make the request
CloudControl response = await configClient.GetCloudControlAsync(request);
GetCloudControlAsync(string, CallSettings)
public virtual Task<CloudControl> GetCloudControlAsync(string name, CallSettings callSettings = null)
Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the CloudControl is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control} |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/cloudControls/[CLOUD_CONTROL]";
// Make the request
CloudControl response = await configClient.GetCloudControlAsync(name);
GetCloudControlAsync(string, CancellationToken)
public virtual Task<CloudControl> GetCloudControlAsync(string name, CancellationToken cancellationToken)
Gets details of a single CloudControl. This method retrieves a CloudControl resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the CloudControl is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control} |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/cloudControls/[CLOUD_CONTROL]";
// Make the request
CloudControl response = await configClient.GetCloudControlAsync(name);
GetFramework(FrameworkName, CallSettings)
public virtual Framework GetFramework(FrameworkName name, CallSettings callSettings = null)
Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the Framework is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
FrameworkName Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id} |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Framework |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
FrameworkName name = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]");
// Make the request
Framework response = configClient.GetFramework(name);
GetFramework(GetFrameworkRequest, CallSettings)
public virtual Framework GetFramework(GetFrameworkRequest request, CallSettings callSettings = null)
Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the Framework is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
request |
GetFrameworkRequest 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 |
Framework |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
GetFrameworkRequest request = new GetFrameworkRequest
{
FrameworkName = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]"),
MajorRevisionId = 0L,
};
// Make the request
Framework response = configClient.GetFramework(request);
GetFramework(string, CallSettings)
public virtual Framework GetFramework(string name, CallSettings callSettings = null)
Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the Framework is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id} |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Framework |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworks/[FRAMEWORK]";
// Make the request
Framework response = configClient.GetFramework(name);
GetFrameworkAsync(FrameworkName, CallSettings)
public virtual Task<Framework> GetFrameworkAsync(FrameworkName name, CallSettings callSettings = null)
Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the Framework is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
FrameworkName Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id} |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
FrameworkName name = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]");
// Make the request
Framework response = await configClient.GetFrameworkAsync(name);
GetFrameworkAsync(FrameworkName, CancellationToken)
public virtual Task<Framework> GetFrameworkAsync(FrameworkName name, CancellationToken cancellationToken)
Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the Framework is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
FrameworkName Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id} |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
FrameworkName name = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]");
// Make the request
Framework response = await configClient.GetFrameworkAsync(name);
GetFrameworkAsync(GetFrameworkRequest, CallSettings)
public virtual Task<Framework> GetFrameworkAsync(GetFrameworkRequest request, CallSettings callSettings = null)
Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the Framework is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
request |
GetFrameworkRequest 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 |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetFrameworkRequest request = new GetFrameworkRequest
{
FrameworkName = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]"),
MajorRevisionId = 0L,
};
// Make the request
Framework response = await configClient.GetFrameworkAsync(request);
GetFrameworkAsync(GetFrameworkRequest, CancellationToken)
public virtual Task<Framework> GetFrameworkAsync(GetFrameworkRequest request, CancellationToken cancellationToken)
Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the Framework is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
request |
GetFrameworkRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
GetFrameworkRequest request = new GetFrameworkRequest
{
FrameworkName = FrameworkName.FromOrganizationLocationFramework("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]"),
MajorRevisionId = 0L,
};
// Make the request
Framework response = await configClient.GetFrameworkAsync(request);
GetFrameworkAsync(string, CallSettings)
public virtual Task<Framework> GetFrameworkAsync(string name, CallSettings callSettings = null)
Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the Framework is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id} |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworks/[FRAMEWORK]";
// Make the request
Framework response = await configClient.GetFrameworkAsync(name);
GetFrameworkAsync(string, CancellationToken)
public virtual Task<Framework> GetFrameworkAsync(string name, CancellationToken cancellationToken)
Gets details of a single Framework. This method retrieves a Framework resource, which can be either Built-in or Custom, identified by its name.
By default, the latest major version of the Framework is returned.
A specific major version can be retrieved by specifying the
major_revision_id
in the request.
Parameters | |
---|---|
Name | Description |
name |
string Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id} |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string name = "organizations/[ORGANIZATION]/locations/[LOCATION]/frameworks/[FRAMEWORK]";
// Make the request
Framework response = await configClient.GetFrameworkAsync(name);
ListCloudControls(ListCloudControlsRequest, CallSettings)
public virtual PagedEnumerable<ListCloudControlsResponse, CloudControl> ListCloudControls(ListCloudControlsRequest request, CallSettings callSettings = null)
Lists all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.
Parameters | |
---|---|
Name | Description |
request |
ListCloudControlsRequest 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 |
PagedEnumerableListCloudControlsResponseCloudControl |
A pageable sequence of CloudControl resources. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ListCloudControlsRequest request = new ListCloudControlsRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListCloudControlsResponse, CloudControl> response = configClient.ListCloudControls(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (CloudControl 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 (ListCloudControlsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (CloudControl 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<CloudControl> 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 (CloudControl 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;
ListCloudControls(OrganizationLocationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListCloudControlsResponse, CloudControl> ListCloudControls(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListCloudControlsResponseCloudControl |
A pageable sequence of CloudControl resources. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedEnumerable<ListCloudControlsResponse, CloudControl> response = configClient.ListCloudControls(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (CloudControl 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 (ListCloudControlsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (CloudControl 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<CloudControl> 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 (CloudControl 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;
ListCloudControls(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListCloudControlsResponse, CloudControl> ListCloudControls(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListCloudControlsResponseCloudControl |
A pageable sequence of CloudControl resources. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListCloudControlsResponse, CloudControl> response = configClient.ListCloudControls(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (CloudControl 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 (ListCloudControlsResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (CloudControl 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<CloudControl> 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 (CloudControl 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;
ListCloudControlsAsync(ListCloudControlsRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListCloudControlsResponse, CloudControl> ListCloudControlsAsync(ListCloudControlsRequest request, CallSettings callSettings = null)
Lists all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.
Parameters | |
---|---|
Name | Description |
request |
ListCloudControlsRequest 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 |
PagedAsyncEnumerableListCloudControlsResponseCloudControl |
A pageable asynchronous sequence of CloudControl resources. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ListCloudControlsRequest request = new ListCloudControlsRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListCloudControlsResponse, CloudControl> response = configClient.ListCloudControlsAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((CloudControl 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((ListCloudControlsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (CloudControl 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<CloudControl> 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 (CloudControl 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;
ListCloudControlsAsync(OrganizationLocationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListCloudControlsResponse, CloudControl> ListCloudControlsAsync(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListCloudControlsResponseCloudControl |
A pageable asynchronous sequence of CloudControl resources. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListCloudControlsResponse, CloudControl> response = configClient.ListCloudControlsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((CloudControl 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((ListCloudControlsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (CloudControl 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<CloudControl> 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 (CloudControl 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;
ListCloudControlsAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListCloudControlsResponse, CloudControl> ListCloudControlsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists all CloudControls (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each CloudControl is returned.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListCloudControlsResponseCloudControl |
A pageable asynchronous sequence of CloudControl resources. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListCloudControlsResponse, CloudControl> response = configClient.ListCloudControlsAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((CloudControl 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((ListCloudControlsResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (CloudControl 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<CloudControl> 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 (CloudControl 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;
ListFrameworks(ListFrameworksRequest, CallSettings)
public virtual PagedEnumerable<ListFrameworksResponse, Framework> ListFrameworks(ListFrameworksRequest request, CallSettings callSettings = null)
Lists all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.
Parameters | |
---|---|
Name | Description |
request |
ListFrameworksRequest 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 |
PagedEnumerableListFrameworksResponseFramework |
A pageable sequence of Framework resources. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
ListFrameworksRequest request = new ListFrameworksRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
};
// Make the request
PagedEnumerable<ListFrameworksResponse, Framework> response = configClient.ListFrameworks(request);
// Iterate over all response items, lazily performing RPCs as required
foreach (Framework 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 (ListFrameworksResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Framework 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<Framework> 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 (Framework 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;
ListFrameworks(OrganizationLocationName, string, int?, CallSettings)
public virtual PagedEnumerable<ListFrameworksResponse, Framework> ListFrameworks(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListFrameworksResponseFramework |
A pageable sequence of Framework resources. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedEnumerable<ListFrameworksResponse, Framework> response = configClient.ListFrameworks(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Framework 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 (ListFrameworksResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Framework 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<Framework> 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 (Framework 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;
ListFrameworks(string, string, int?, CallSettings)
public virtual PagedEnumerable<ListFrameworksResponse, Framework> ListFrameworks(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerableListFrameworksResponseFramework |
A pageable sequence of Framework resources. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListFrameworksResponse, Framework> response = configClient.ListFrameworks(parent);
// Iterate over all response items, lazily performing RPCs as required
foreach (Framework 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 (ListFrameworksResponse page in response.AsRawResponses())
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Framework 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<Framework> 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 (Framework 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;
ListFrameworksAsync(ListFrameworksRequest, CallSettings)
public virtual PagedAsyncEnumerable<ListFrameworksResponse, Framework> ListFrameworksAsync(ListFrameworksRequest request, CallSettings callSettings = null)
Lists all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.
Parameters | |
---|---|
Name | Description |
request |
ListFrameworksRequest 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 |
PagedAsyncEnumerableListFrameworksResponseFramework |
A pageable asynchronous sequence of Framework resources. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
ListFrameworksRequest request = new ListFrameworksRequest
{
ParentAsOrganizationLocationName = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]"),
};
// Make the request
PagedAsyncEnumerable<ListFrameworksResponse, Framework> response = configClient.ListFrameworksAsync(request);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Framework 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((ListFrameworksResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Framework 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<Framework> 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 (Framework 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;
ListFrameworksAsync(OrganizationLocationName, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListFrameworksResponse, Framework> ListFrameworksAsync(OrganizationLocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.
Parameters | |
---|---|
Name | Description |
parent |
OrganizationLocationName Required. The parent resource name, in the format
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListFrameworksResponseFramework |
A pageable asynchronous sequence of Framework resources. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
OrganizationLocationName parent = OrganizationLocationName.FromOrganizationLocation("[ORGANIZATION]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListFrameworksResponse, Framework> response = configClient.ListFrameworksAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Framework 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((ListFrameworksResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Framework 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<Framework> 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 (Framework 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;
ListFrameworksAsync(string, string, int?, CallSettings)
public virtual PagedAsyncEnumerable<ListFrameworksResponse, Framework> ListFrameworksAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)
Lists all Frameworks (both Built-in and Custom) available within a given parent resource. This method supports pagination. The latest major version of each Framework is returned.
Parameters | |
---|---|
Name | Description |
parent |
string Required. The parent resource name, in the format
|
pageToken |
string The token returned from the previous request. A value of |
pageSize |
int The size of page to request. The response will not be larger than this, but may be smaller. A value of
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerableListFrameworksResponseFramework |
A pageable asynchronous sequence of Framework resources. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
string parent = "organizations/[ORGANIZATION]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListFrameworksResponse, Framework> response = configClient.ListFrameworksAsync(parent);
// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Framework 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((ListFrameworksResponse page) =>
{
// Do something with each page of items
Console.WriteLine("A page of results:");
foreach (Framework 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<Framework> 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 (Framework 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;
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. |
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.
UpdateCloudControl(CloudControl, FieldMask, CallSettings)
public virtual CloudControl UpdateCloudControl(CloudControl cloudControl, FieldMask updateMask, CallSettings callSettings = null)
Updates a single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'scloud_control
body will be used to overwrite the existing resource.
A successful update will result in a new version of the CloudControl.
Parameters | |
---|---|
Name | Description |
cloudControl |
CloudControl Required. The resource being updated |
updateMask |
FieldMask Optional. Field mask is used to specify the fields to be overwritten in the CloudControl resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. The fields that can be updated are:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
CloudControl |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
CloudControl cloudControl = new CloudControl();
FieldMask updateMask = new FieldMask();
// Make the request
CloudControl response = configClient.UpdateCloudControl(cloudControl, updateMask);
UpdateCloudControl(UpdateCloudControlRequest, CallSettings)
public virtual CloudControl UpdateCloudControl(UpdateCloudControlRequest request, CallSettings callSettings = null)
Updates a single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'scloud_control
body will be used to overwrite the existing resource.
A successful update will result in a new version of the CloudControl.
Parameters | |
---|---|
Name | Description |
request |
UpdateCloudControlRequest 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 |
CloudControl |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
UpdateCloudControlRequest request = new UpdateCloudControlRequest
{
UpdateMask = new FieldMask(),
CloudControl = new CloudControl(),
};
// Make the request
CloudControl response = configClient.UpdateCloudControl(request);
UpdateCloudControlAsync(CloudControl, FieldMask, CallSettings)
public virtual Task<CloudControl> UpdateCloudControlAsync(CloudControl cloudControl, FieldMask updateMask, CallSettings callSettings = null)
Updates a single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'scloud_control
body will be used to overwrite the existing resource.
A successful update will result in a new version of the CloudControl.
Parameters | |
---|---|
Name | Description |
cloudControl |
CloudControl Required. The resource being updated |
updateMask |
FieldMask Optional. Field mask is used to specify the fields to be overwritten in the CloudControl resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. The fields that can be updated are:
|
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CloudControl cloudControl = new CloudControl();
FieldMask updateMask = new FieldMask();
// Make the request
CloudControl response = await configClient.UpdateCloudControlAsync(cloudControl, updateMask);
UpdateCloudControlAsync(CloudControl, FieldMask, CancellationToken)
public virtual Task<CloudControl> UpdateCloudControlAsync(CloudControl cloudControl, FieldMask updateMask, CancellationToken cancellationToken)
Updates a single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'scloud_control
body will be used to overwrite the existing resource.
A successful update will result in a new version of the CloudControl.
Parameters | |
---|---|
Name | Description |
cloudControl |
CloudControl Required. The resource being updated |
updateMask |
FieldMask Optional. Field mask is used to specify the fields to be overwritten in the CloudControl resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. The fields that can be updated are:
|
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
CloudControl cloudControl = new CloudControl();
FieldMask updateMask = new FieldMask();
// Make the request
CloudControl response = await configClient.UpdateCloudControlAsync(cloudControl, updateMask);
UpdateCloudControlAsync(UpdateCloudControlRequest, CallSettings)
public virtual Task<CloudControl> UpdateCloudControlAsync(UpdateCloudControlRequest request, CallSettings callSettings = null)
Updates a single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'scloud_control
body will be used to overwrite the existing resource.
A successful update will result in a new version of the CloudControl.
Parameters | |
---|---|
Name | Description |
request |
UpdateCloudControlRequest 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 |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
UpdateCloudControlRequest request = new UpdateCloudControlRequest
{
UpdateMask = new FieldMask(),
CloudControl = new CloudControl(),
};
// Make the request
CloudControl response = await configClient.UpdateCloudControlAsync(request);
UpdateCloudControlAsync(UpdateCloudControlRequest, CancellationToken)
public virtual Task<CloudControl> UpdateCloudControlAsync(UpdateCloudControlRequest request, CancellationToken cancellationToken)
Updates a single CloudControl. This method allows for partial updates of a Custom CloudControl resource. Built-in CloudControls cannot be updated.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'scloud_control
body will be used to overwrite the existing resource.
A successful update will result in a new version of the CloudControl.
Parameters | |
---|---|
Name | Description |
request |
UpdateCloudControlRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskCloudControl |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
UpdateCloudControlRequest request = new UpdateCloudControlRequest
{
UpdateMask = new FieldMask(),
CloudControl = new CloudControl(),
};
// Make the request
CloudControl response = await configClient.UpdateCloudControlAsync(request);
UpdateFramework(Framework, FieldMask, CallSettings)
public virtual Framework UpdateFramework(Framework framework, FieldMask updateMask, CallSettings callSettings = null)
Updates a single Framework.
This method allows for partial updates of a Framework resource. The fields
to be updated are specified using the update_mask
.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'sframework
body will be used to overwrite the existing resource.
This operation can only be performed on Frameworks with type CUSTOM
.
A successful update will result in a new version of the Framework.
Parameters | |
---|---|
Name | Description |
framework |
Framework Required. The resource being updated |
updateMask |
FieldMask Optional. Field mask is used to specify the fields to be overwritten in the Framework resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Framework |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
Framework framework = new Framework();
FieldMask updateMask = new FieldMask();
// Make the request
Framework response = configClient.UpdateFramework(framework, updateMask);
UpdateFramework(UpdateFrameworkRequest, CallSettings)
public virtual Framework UpdateFramework(UpdateFrameworkRequest request, CallSettings callSettings = null)
Updates a single Framework.
This method allows for partial updates of a Framework resource. The fields
to be updated are specified using the update_mask
.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'sframework
body will be used to overwrite the existing resource.
This operation can only be performed on Frameworks with type CUSTOM
.
A successful update will result in a new version of the Framework.
Parameters | |
---|---|
Name | Description |
request |
UpdateFrameworkRequest 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 |
Framework |
The RPC response. |
// Create client
ConfigClient configClient = ConfigClient.Create();
// Initialize request argument(s)
UpdateFrameworkRequest request = new UpdateFrameworkRequest
{
UpdateMask = new FieldMask(),
Framework = new Framework(),
MajorRevisionId = 0L,
};
// Make the request
Framework response = configClient.UpdateFramework(request);
UpdateFrameworkAsync(Framework, FieldMask, CallSettings)
public virtual Task<Framework> UpdateFrameworkAsync(Framework framework, FieldMask updateMask, CallSettings callSettings = null)
Updates a single Framework.
This method allows for partial updates of a Framework resource. The fields
to be updated are specified using the update_mask
.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'sframework
body will be used to overwrite the existing resource.
This operation can only be performed on Frameworks with type CUSTOM
.
A successful update will result in a new version of the Framework.
Parameters | |
---|---|
Name | Description |
framework |
Framework Required. The resource being updated |
updateMask |
FieldMask Optional. Field mask is used to specify the fields to be overwritten in the Framework resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. |
callSettings |
CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
Framework framework = new Framework();
FieldMask updateMask = new FieldMask();
// Make the request
Framework response = await configClient.UpdateFrameworkAsync(framework, updateMask);
UpdateFrameworkAsync(Framework, FieldMask, CancellationToken)
public virtual Task<Framework> UpdateFrameworkAsync(Framework framework, FieldMask updateMask, CancellationToken cancellationToken)
Updates a single Framework.
This method allows for partial updates of a Framework resource. The fields
to be updated are specified using the update_mask
.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'sframework
body will be used to overwrite the existing resource.
This operation can only be performed on Frameworks with type CUSTOM
.
A successful update will result in a new version of the Framework.
Parameters | |
---|---|
Name | Description |
framework |
Framework Required. The resource being updated |
updateMask |
FieldMask Optional. Field mask is used to specify the fields to be overwritten in the Framework resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
Framework framework = new Framework();
FieldMask updateMask = new FieldMask();
// Make the request
Framework response = await configClient.UpdateFrameworkAsync(framework, updateMask);
UpdateFrameworkAsync(UpdateFrameworkRequest, CallSettings)
public virtual Task<Framework> UpdateFrameworkAsync(UpdateFrameworkRequest request, CallSettings callSettings = null)
Updates a single Framework.
This method allows for partial updates of a Framework resource. The fields
to be updated are specified using the update_mask
.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'sframework
body will be used to overwrite the existing resource.
This operation can only be performed on Frameworks with type CUSTOM
.
A successful update will result in a new version of the Framework.
Parameters | |
---|---|
Name | Description |
request |
UpdateFrameworkRequest 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 |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
UpdateFrameworkRequest request = new UpdateFrameworkRequest
{
UpdateMask = new FieldMask(),
Framework = new Framework(),
MajorRevisionId = 0L,
};
// Make the request
Framework response = await configClient.UpdateFrameworkAsync(request);
UpdateFrameworkAsync(UpdateFrameworkRequest, CancellationToken)
public virtual Task<Framework> UpdateFrameworkAsync(UpdateFrameworkRequest request, CancellationToken cancellationToken)
Updates a single Framework.
This method allows for partial updates of a Framework resource. The fields
to be updated are specified using the update_mask
.
- If an
update_mask
is provided, only the fields specified in the mask will be updated. - If no
update_mask
is provided, all fields present in the request'sframework
body will be used to overwrite the existing resource.
This operation can only be performed on Frameworks with type CUSTOM
.
A successful update will result in a new version of the Framework.
Parameters | |
---|---|
Name | Description |
request |
UpdateFrameworkRequest The request object containing all of the parameters for the API call. |
cancellationToken |
CancellationToken A CancellationToken to use for this RPC. |
Returns | |
---|---|
Type | Description |
TaskFramework |
A Task containing the RPC response. |
// Create client
ConfigClient configClient = await ConfigClient.CreateAsync();
// Initialize request argument(s)
UpdateFrameworkRequest request = new UpdateFrameworkRequest
{
UpdateMask = new FieldMask(),
Framework = new Framework(),
MajorRevisionId = 0L,
};
// Make the request
Framework response = await configClient.UpdateFrameworkAsync(request);