Class ConfigClient (0.1.0)

Service Description: Service describing handlers for config resources

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   FrameworkName name = FrameworkName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]");
   Framework response = configClient.getFramework(name);
 }

Note: close() needs to be called on the ConfigClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
ListFrameworks	Lists Frameworks in a given organization.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listFrameworks(ListFrameworksRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listFrameworks(OrganizationLocationName parent) listFrameworks(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listFrameworksPagedCallable() listFrameworksCallable()
GetFramework	Gets details of a single Framework.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getFramework(GetFrameworkRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getFramework(FrameworkName name) getFramework(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getFrameworkCallable()
CreateFramework	Creates a single framework for a given resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createFramework(CreateFrameworkRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createFramework(OrganizationLocationName parent, Framework framework, String frameworkId) createFramework(String parent, Framework framework, String frameworkId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createFrameworkCallable()
UpdateFramework	Updates a single Framework.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateFramework(UpdateFrameworkRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateFramework(Framework framework, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateFrameworkCallable()
DeleteFramework	Deletes a single Framework.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteFramework(DeleteFrameworkRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteFramework(FrameworkName name) deleteFramework(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteFrameworkCallable()
ListCloudControls	Lists CloudControls in a given organization.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCloudControls(ListCloudControlsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCloudControls(OrganizationLocationName parent) listCloudControls(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCloudControlsPagedCallable() listCloudControlsCallable()
GetCloudControl	Gets details of a single CloudControl.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCloudControl(GetCloudControlRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCloudControl(CloudControlName name) getCloudControl(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCloudControlCallable()
CreateCloudControl	Creates a single CloudControl for a given resource.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createCloudControl(CreateCloudControlRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createCloudControl(OrganizationLocationName parent, CloudControl cloudControl, String cloudControlId) createCloudControl(String parent, CloudControl cloudControl, String cloudControlId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createCloudControlCallable()
UpdateCloudControl	Updates a single CloudControl.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCloudControl(UpdateCloudControlRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateCloudControl(CloudControl cloudControl, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCloudControlCallable()
DeleteCloudControl	Deletes a single CloudControl.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteCloudControl(DeleteCloudControlRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteCloudControl(CloudControlName name) deleteCloudControl(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteCloudControlCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ConfigSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ConfigSettings configSettings =
     ConfigSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConfigClient configClient = ConfigClient.create(configSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ConfigSettings configSettings = ConfigSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConfigClient configClient = ConfigClient.create(configSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ConfigSettings configSettings = ConfigSettings.newHttpJsonBuilder().build();
 ConfigClient configClient = ConfigClient.create(configSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ConfigClient

Static Methods

create()

public static final ConfigClient create()

Constructs an instance of ConfigClient with default settings.

Returns
Type	Description
`ConfigClient`

Exceptions
Type	Description
`IOException`

create(ConfigSettings settings)

public static final ConfigClient create(ConfigSettings settings)

Constructs an instance of ConfigClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`ConfigSettings`

Returns
Type	Description
`ConfigClient`

Exceptions
Type	Description
`IOException`

create(ConfigStub stub)

public static final ConfigClient create(ConfigStub stub)

Constructs an instance of ConfigClient, using the given stub for making calls. This is for advanced usage - prefer using create(ConfigSettings).

Parameter
Name	Description
`stub`	`ConfigStub`

Returns
Type	Description
`ConfigClient`

Constructors

ConfigClient(ConfigSettings settings)

protected ConfigClient(ConfigSettings settings)

Constructs an instance of ConfigClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`ConfigSettings`

ConfigClient(ConfigStub stub)

protected ConfigClient(ConfigStub stub)

Parameter
Name	Description
`stub`	`ConfigStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

createCloudControl(CreateCloudControlRequest request)

public final CloudControl createCloudControl(CreateCloudControlRequest request)

Creates a single CloudControl for a given resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   CreateCloudControlRequest request =
       CreateCloudControlRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setCloudControlId("cloudControlId657324195")
           .setCloudControl(CloudControl.newBuilder().build())
           .build();
   CloudControl response = configClient.createCloudControl(request);
 }

Parameter
Name	Description
`request`	`CreateCloudControlRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudControl`

createCloudControl(OrganizationLocationName parent, CloudControl cloudControl, String cloudControlId)

public final CloudControl createCloudControl(OrganizationLocationName parent, CloudControl cloudControl, String cloudControlId)

Creates a single CloudControl for a given resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   CloudControl cloudControl = CloudControl.newBuilder().build();
   String cloudControlId = "cloudControlId657324195";
   CloudControl response = configClient.createCloudControl(parent, cloudControl, cloudControlId);
 }

Parameters
Name	Description
`parent`	`OrganizationLocationName` Required. The parent resource name, in the format `organizations/{organization}/locations/{location}`.
`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: `^a-zA-Z{0,61}[a-zA-Z0-9]$`.

Returns
Type	Description
`CloudControl`

createCloudControl(String parent, CloudControl cloudControl, String cloudControlId)

public final CloudControl createCloudControl(String parent, CloudControl cloudControl, String cloudControlId)

Creates a single CloudControl for a given resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   CloudControl cloudControl = CloudControl.newBuilder().build();
   String cloudControlId = "cloudControlId657324195";
   CloudControl response = configClient.createCloudControl(parent, cloudControl, cloudControlId);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource name, in the format `organizations/{organization}/locations/{location}`.
`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: `^a-zA-Z{0,61}[a-zA-Z0-9]$`.

Returns
Type	Description
`CloudControl`

createCloudControlCallable()

public final UnaryCallable<CreateCloudControlRequest,CloudControl> createCloudControlCallable()

Creates a single CloudControl for a given resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   CreateCloudControlRequest request =
       CreateCloudControlRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setCloudControlId("cloudControlId657324195")
           .setCloudControl(CloudControl.newBuilder().build())
           .build();
   ApiFuture<CloudControl> future =
       configClient.createCloudControlCallable().futureCall(request);
   // Do something.
   CloudControl response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateCloudControlRequest,CloudControl>`

createFramework(CreateFrameworkRequest request)

public final Framework createFramework(CreateFrameworkRequest request)

Creates a single framework for a given resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   CreateFrameworkRequest request =
       CreateFrameworkRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setFrameworkId("frameworkId886666169")
           .setFramework(Framework.newBuilder().build())
           .build();
   Framework response = configClient.createFramework(request);
 }

Parameter
Name	Description
`request`	`CreateFrameworkRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Framework`

createFramework(OrganizationLocationName parent, Framework framework, String frameworkId)

public final Framework createFramework(OrganizationLocationName parent, Framework framework, String frameworkId)

Creates a single framework for a given resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   Framework framework = Framework.newBuilder().build();
   String frameworkId = "frameworkId886666169";
   Framework response = configClient.createFramework(parent, framework, frameworkId);
 }

Parameters
Name	Description
`parent`	`OrganizationLocationName` Required. The parent resource name, in the format `organizations/{organization}/locations/{location}`.
`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.

Returns
Type	Description
`Framework`

createFramework(String parent, Framework framework, String frameworkId)

public final Framework createFramework(String parent, Framework framework, String frameworkId)

Creates a single framework for a given resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   Framework framework = Framework.newBuilder().build();
   String frameworkId = "frameworkId886666169";
   Framework response = configClient.createFramework(parent, framework, frameworkId);
 }

Parameters
Name	Description
`parent`	`String` Required. The parent resource name, in the format `organizations/{organization}/locations/{location}`.
`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.

Returns
Type	Description
`Framework`

createFrameworkCallable()

public final UnaryCallable<CreateFrameworkRequest,Framework> createFrameworkCallable()

Creates a single framework for a given resource.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   CreateFrameworkRequest request =
       CreateFrameworkRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setFrameworkId("frameworkId886666169")
           .setFramework(Framework.newBuilder().build())
           .build();
   ApiFuture<Framework> future = configClient.createFrameworkCallable().futureCall(request);
   // Do something.
   Framework response = future.get();
 }

Returns
Type	Description
`UnaryCallable<CreateFrameworkRequest,Framework>`

deleteCloudControl(CloudControlName name)

public final void deleteCloudControl(CloudControlName name)

Deletes a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   CloudControlName name =
       CloudControlName.of("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]");
   configClient.deleteCloudControl(name);
 }

Parameter
Name	Description
`name`	`CloudControlName` Required. Name of the resource, in the format `organizations/{organization}/locations/{location}/CloudControls/{CloudControl}`.

deleteCloudControl(DeleteCloudControlRequest request)

public final void deleteCloudControl(DeleteCloudControlRequest request)

Deletes a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   DeleteCloudControlRequest request =
       DeleteCloudControlRequest.newBuilder()
           .setName(
               CloudControlName.of("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]").toString())
           .build();
   configClient.deleteCloudControl(request);
 }

Parameter
Name	Description
`request`	`DeleteCloudControlRequest` The request object containing all of the parameters for the API call.

deleteCloudControl(String name)

public final void deleteCloudControl(String name)

Deletes a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   String name =
       CloudControlName.of("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]").toString();
   configClient.deleteCloudControl(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the resource, in the format `organizations/{organization}/locations/{location}/CloudControls/{CloudControl}`.

deleteCloudControlCallable()

public final UnaryCallable<DeleteCloudControlRequest,Empty> deleteCloudControlCallable()

Deletes a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   DeleteCloudControlRequest request =
       DeleteCloudControlRequest.newBuilder()
           .setName(
               CloudControlName.of("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]").toString())
           .build();
   ApiFuture<Empty> future = configClient.deleteCloudControlCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteCloudControlRequest,Empty>`

deleteFramework(DeleteFrameworkRequest request)

public final void deleteFramework(DeleteFrameworkRequest request)

Deletes a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   DeleteFrameworkRequest request =
       DeleteFrameworkRequest.newBuilder()
           .setName(FrameworkName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]").toString())
           .build();
   configClient.deleteFramework(request);
 }

Parameter
Name	Description
`request`	`DeleteFrameworkRequest` The request object containing all of the parameters for the API call.

deleteFramework(FrameworkName name)

public final void deleteFramework(FrameworkName name)

Deletes a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   FrameworkName name = FrameworkName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]");
   configClient.deleteFramework(name);
 }

Parameter
Name	Description
`name`	`FrameworkName` Required. Name of the resource, in the format `organizations/{organization}/locations/{location}/frameworks/{framework}`.

deleteFramework(String name)

public final void deleteFramework(String name)

Deletes a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   String name = FrameworkName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]").toString();
   configClient.deleteFramework(name);
 }

Parameter
Name	Description
`name`	`String` Required. Name of the resource, in the format `organizations/{organization}/locations/{location}/frameworks/{framework}`.

deleteFrameworkCallable()

public final UnaryCallable<DeleteFrameworkRequest,Empty> deleteFrameworkCallable()

Deletes a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   DeleteFrameworkRequest request =
       DeleteFrameworkRequest.newBuilder()
           .setName(FrameworkName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]").toString())
           .build();
   ApiFuture<Empty> future = configClient.deleteFrameworkCallable().futureCall(request);
   // Do something.
   future.get();
 }

Returns
Type	Description
`UnaryCallable<DeleteFrameworkRequest,Empty>`

getCloudControl(CloudControlName name)

public final CloudControl getCloudControl(CloudControlName name)

Gets details of a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   CloudControlName name =
       CloudControlName.of("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]");
   CloudControl response = configClient.getCloudControl(name);
 }

Parameter
Name	Description
`name`	`CloudControlName` Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control}

Returns
Type	Description
`CloudControl`

getCloudControl(GetCloudControlRequest request)

public final CloudControl getCloudControl(GetCloudControlRequest request)

Gets details of a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   GetCloudControlRequest request =
       GetCloudControlRequest.newBuilder()
           .setName(
               CloudControlName.of("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]").toString())
           .build();
   CloudControl response = configClient.getCloudControl(request);
 }

Parameter
Name	Description
`request`	`GetCloudControlRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudControl`

getCloudControl(String name)

public final CloudControl getCloudControl(String name)

Gets details of a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   String name =
       CloudControlName.of("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]").toString();
   CloudControl response = configClient.getCloudControl(name);
 }

Parameter
Name	Description
`name`	`String` Required. The name of the cloudcontrol to retrieve in the format: organizations/{organization}/locations/{location}/cloudControls/{cloud_control}

Returns
Type	Description
`CloudControl`

getCloudControlCallable()

public final UnaryCallable<GetCloudControlRequest,CloudControl> getCloudControlCallable()

Gets details of a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   GetCloudControlRequest request =
       GetCloudControlRequest.newBuilder()
           .setName(
               CloudControlName.of("[ORGANIZATION]", "[LOCATION]", "[CLOUD_CONTROL]").toString())
           .build();
   ApiFuture<CloudControl> future = configClient.getCloudControlCallable().futureCall(request);
   // Do something.
   CloudControl response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetCloudControlRequest,CloudControl>`

getFramework(FrameworkName name)

public final Framework getFramework(FrameworkName name)

Gets details of a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   FrameworkName name = FrameworkName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]");
   Framework response = configClient.getFramework(name);
 }

Parameter
Name	Description
`name`	`FrameworkName` Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}

Returns
Type	Description
`Framework`

getFramework(GetFrameworkRequest request)

public final Framework getFramework(GetFrameworkRequest request)

Gets details of a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   GetFrameworkRequest request =
       GetFrameworkRequest.newBuilder()
           .setName(FrameworkName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]").toString())
           .setMajorRevisionId(612576889)
           .build();
   Framework response = configClient.getFramework(request);
 }

Parameter
Name	Description
`request`	`GetFrameworkRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Framework`

getFramework(String name)

public final Framework getFramework(String name)

Gets details of a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   String name = FrameworkName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]").toString();
   Framework response = configClient.getFramework(name);
 }

Parameter
Name	Description
`name`	`String` Required. The name of the framework to retrieve. Format: organizations/{organization}/locations/{location}/frameworks/{framework_id}

Returns
Type	Description
`Framework`

getFrameworkCallable()

public final UnaryCallable<GetFrameworkRequest,Framework> getFrameworkCallable()

Gets details of a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   GetFrameworkRequest request =
       GetFrameworkRequest.newBuilder()
           .setName(FrameworkName.of("[ORGANIZATION]", "[LOCATION]", "[FRAMEWORK]").toString())
           .setMajorRevisionId(612576889)
           .build();
   ApiFuture<Framework> future = configClient.getFrameworkCallable().futureCall(request);
   // Do something.
   Framework response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetFrameworkRequest,Framework>`

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = configClient.getLocation(request);
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = configClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getSettings()

public final ConfigSettings getSettings()

Returns
Type	Description
`ConfigSettings`

getStub()

public ConfigStub getStub()

Returns
Type	Description
`ConfigStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listCloudControls(ListCloudControlsRequest request)

public final ConfigClient.ListCloudControlsPagedResponse listCloudControls(ListCloudControlsRequest request)

Lists CloudControls in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   ListCloudControlsRequest request =
       ListCloudControlsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (CloudControl element : configClient.listCloudControls(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListCloudControlsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ConfigClient.ListCloudControlsPagedResponse`

listCloudControls(OrganizationLocationName parent)

public final ConfigClient.ListCloudControlsPagedResponse listCloudControls(OrganizationLocationName parent)

Lists CloudControls in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (CloudControl element : configClient.listCloudControls(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`OrganizationLocationName` Required. The parent resource name, in the format `organizations/{organization}/locations/{location}`.

Returns
Type	Description
`ConfigClient.ListCloudControlsPagedResponse`

listCloudControls(String parent)

public final ConfigClient.ListCloudControlsPagedResponse listCloudControls(String parent)

Lists CloudControls in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (CloudControl element : configClient.listCloudControls(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent resource name, in the format `organizations/{organization}/locations/{location}`.

Returns
Type	Description
`ConfigClient.ListCloudControlsPagedResponse`

listCloudControlsCallable()

public final UnaryCallable<ListCloudControlsRequest,ListCloudControlsResponse> listCloudControlsCallable()

Lists CloudControls in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   ListCloudControlsRequest request =
       ListCloudControlsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCloudControlsResponse response = configClient.listCloudControlsCallable().call(request);
     for (CloudControl element : response.getCloudControlsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListCloudControlsRequest,ListCloudControlsResponse>`

listCloudControlsPagedCallable()

public final UnaryCallable<ListCloudControlsRequest,ConfigClient.ListCloudControlsPagedResponse> listCloudControlsPagedCallable()

Lists CloudControls in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   ListCloudControlsRequest request =
       ListCloudControlsRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<CloudControl> future =
       configClient.listCloudControlsPagedCallable().futureCall(request);
   // Do something.
   for (CloudControl element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListCloudControlsRequest,ListCloudControlsPagedResponse>`

listFrameworks(ListFrameworksRequest request)

public final ConfigClient.ListFrameworksPagedResponse listFrameworks(ListFrameworksRequest request)

Lists Frameworks in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   ListFrameworksRequest request =
       ListFrameworksRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Framework element : configClient.listFrameworks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListFrameworksRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ConfigClient.ListFrameworksPagedResponse`

listFrameworks(OrganizationLocationName parent)

public final ConfigClient.ListFrameworksPagedResponse listFrameworks(OrganizationLocationName parent)

Lists Frameworks in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
   for (Framework element : configClient.listFrameworks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`OrganizationLocationName` Required. The parent resource name, in the format `organizations/{organization}/locations/{location}`.

Returns
Type	Description
`ConfigClient.ListFrameworksPagedResponse`

listFrameworks(String parent)

public final ConfigClient.ListFrameworksPagedResponse listFrameworks(String parent)

Lists Frameworks in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
   for (Framework element : configClient.listFrameworks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent resource name, in the format `organizations/{organization}/locations/{location}`.

Returns
Type	Description
`ConfigClient.ListFrameworksPagedResponse`

listFrameworksCallable()

public final UnaryCallable<ListFrameworksRequest,ListFrameworksResponse> listFrameworksCallable()

Lists Frameworks in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   ListFrameworksRequest request =
       ListFrameworksRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListFrameworksResponse response = configClient.listFrameworksCallable().call(request);
     for (Framework element : response.getFrameworksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListFrameworksRequest,ListFrameworksResponse>`

listFrameworksPagedCallable()

public final UnaryCallable<ListFrameworksRequest,ConfigClient.ListFrameworksPagedResponse> listFrameworksPagedCallable()

Lists Frameworks in a given organization.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   ListFrameworksRequest request =
       ListFrameworksRequest.newBuilder()
           .setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Framework> future = configClient.listFrameworksPagedCallable().futureCall(request);
   // Do something.
   for (Framework element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListFrameworksRequest,ListFrameworksPagedResponse>`

listLocations(ListLocationsRequest request)

public final ConfigClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : configClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ConfigClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = configClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,ConfigClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = configClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateCloudControl(CloudControl cloudControl, FieldMask updateMask)

public final CloudControl updateCloudControl(CloudControl cloudControl, FieldMask updateMask)

Updates a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   CloudControl cloudControl = CloudControl.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   CloudControl response = configClient.updateCloudControl(cloudControl, updateMask);
 }

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: 1. Display_name 2. Description 3. Parameters 4. Rules 5. ParameterSpec.

Returns
Type	Description
`CloudControl`

updateCloudControl(UpdateCloudControlRequest request)

public final CloudControl updateCloudControl(UpdateCloudControlRequest request)

Updates a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   UpdateCloudControlRequest request =
       UpdateCloudControlRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCloudControl(CloudControl.newBuilder().build())
           .build();
   CloudControl response = configClient.updateCloudControl(request);
 }

Parameter
Name	Description
`request`	`UpdateCloudControlRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CloudControl`

updateCloudControlCallable()

public final UnaryCallable<UpdateCloudControlRequest,CloudControl> updateCloudControlCallable()

Updates a single CloudControl.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   UpdateCloudControlRequest request =
       UpdateCloudControlRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCloudControl(CloudControl.newBuilder().build())
           .build();
   ApiFuture<CloudControl> future =
       configClient.updateCloudControlCallable().futureCall(request);
   // Do something.
   CloudControl response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateCloudControlRequest,CloudControl>`

updateFramework(Framework framework, FieldMask updateMask)

public final Framework updateFramework(Framework framework, FieldMask updateMask)

Updates a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   Framework framework = Framework.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Framework response = configClient.updateFramework(framework, updateMask);
 }

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.

Returns
Type	Description
`Framework`

updateFramework(UpdateFrameworkRequest request)

public final Framework updateFramework(UpdateFrameworkRequest request)

Updates a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   UpdateFrameworkRequest request =
       UpdateFrameworkRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setFramework(Framework.newBuilder().build())
           .setMajorRevisionId(612576889)
           .build();
   Framework response = configClient.updateFramework(request);
 }

Parameter
Name	Description
`request`	`UpdateFrameworkRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Framework`

updateFrameworkCallable()

public final UnaryCallable<UpdateFrameworkRequest,Framework> updateFrameworkCallable()

Updates a single Framework.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ConfigClient configClient = ConfigClient.create()) {
   UpdateFrameworkRequest request =
       UpdateFrameworkRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setFramework(Framework.newBuilder().build())
           .setMajorRevisionId(612576889)
           .build();
   ApiFuture<Framework> future = configClient.updateFrameworkCallable().futureCall(request);
   // Do something.
   Framework response = future.get();
 }

Returns
Type	Description
`UnaryCallable<UpdateFrameworkRequest,Framework>`

Class ConfigClient (0.1.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(ConfigSettings settings)

create(ConfigStub stub)

Constructors

ConfigClient(ConfigSettings settings)

ConfigClient(ConfigStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

createCloudControl(CreateCloudControlRequest request)

createCloudControl(OrganizationLocationName parent, CloudControl cloudControl, String cloudControlId)

createCloudControl(String parent, CloudControl cloudControl, String cloudControlId)

createCloudControlCallable()

createFramework(CreateFrameworkRequest request)

createFramework(OrganizationLocationName parent, Framework framework, String frameworkId)

createFramework(String parent, Framework framework, String frameworkId)

createFrameworkCallable()

deleteCloudControl(CloudControlName name)

deleteCloudControl(DeleteCloudControlRequest request)

deleteCloudControl(String name)

deleteCloudControlCallable()

deleteFramework(DeleteFrameworkRequest request)

deleteFramework(FrameworkName name)

deleteFramework(String name)

deleteFrameworkCallable()

getCloudControl(CloudControlName name)

getCloudControl(GetCloudControlRequest request)

getCloudControl(String name)

getCloudControlCallable()

getFramework(FrameworkName name)

getFramework(GetFrameworkRequest request)

getFramework(String name)

getFrameworkCallable()

getLocation(GetLocationRequest request)

getLocationCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listCloudControls(ListCloudControlsRequest request)

listCloudControls(OrganizationLocationName parent)

listCloudControls(String parent)

listCloudControlsCallable()

listCloudControlsPagedCallable()

listFrameworks(ListFrameworksRequest request)

listFrameworks(OrganizationLocationName parent)

listFrameworks(String parent)

listFrameworksCallable()

listFrameworksPagedCallable()

listLocations(ListLocationsRequest request)

listLocationsCallable()

listLocationsPagedCallable()

shutdown()

shutdownNow()

updateCloudControl(CloudControl cloudControl, FieldMask updateMask)

updateCloudControl(UpdateCloudControlRequest request)

updateCloudControlCallable()

updateFramework(Framework framework, FieldMask updateMask)

updateFramework(UpdateFrameworkRequest request)

updateFrameworkCallable()

Class ConfigClient (0.1.0)