Class SystemPolicyV1Beta1Client (1.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 1.79.0 (latest)
- 1.77.0
- 1.75.0
- 1.74.0
- 1.73.0
- 1.72.0
- 1.71.0
- 1.69.0
- 1.67.0
- 1.66.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.0.6
publicclass SystemPolicyV1Beta1ClientimplementsBackgroundResourceService Description: API for working with the system policy.
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(SystemPolicyV1Beta1ClientsystemPolicyV1Beta1Client=SystemPolicyV1Beta1Client.create()){
PolicyNamename=PolicyName.ofLocationName("[LOCATION]");
Policyresponse=systemPolicyV1Beta1Client.getSystemPolicy(name);
}
Note: close() needs to be called on the SystemPolicyV1Beta1Client object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
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 SystemPolicyV1Beta1Settings 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
SystemPolicyV1Beta1SettingssystemPolicyV1Beta1Settings=
SystemPolicyV1Beta1Settings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SystemPolicyV1Beta1ClientsystemPolicyV1Beta1Client=
SystemPolicyV1Beta1Client.create(systemPolicyV1Beta1Settings);
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
SystemPolicyV1Beta1SettingssystemPolicyV1Beta1Settings=
SystemPolicyV1Beta1Settings.newBuilder().setEndpoint(myEndpoint).build();
SystemPolicyV1Beta1ClientsystemPolicyV1Beta1Client=
SystemPolicyV1Beta1Client.create(systemPolicyV1Beta1Settings);
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
SystemPolicyV1Beta1SettingssystemPolicyV1Beta1Settings=
SystemPolicyV1Beta1Settings.newHttpJsonBuilder().build();
SystemPolicyV1Beta1ClientsystemPolicyV1Beta1Client=
SystemPolicyV1Beta1Client.create(systemPolicyV1Beta1Settings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceInherited Members
Static Methods
create()
publicstaticfinalSystemPolicyV1Beta1Clientcreate()Constructs an instance of SystemPolicyV1Beta1Client with default settings.
create(SystemPolicyV1Beta1Settings settings)
publicstaticfinalSystemPolicyV1Beta1Clientcreate(SystemPolicyV1Beta1Settingssettings)Constructs an instance of SystemPolicyV1Beta1Client, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
create(SystemPolicyV1Beta1Stub stub)
publicstaticfinalSystemPolicyV1Beta1Clientcreate(SystemPolicyV1Beta1Stubstub)Constructs an instance of SystemPolicyV1Beta1Client, using the given stub for making calls. This is for advanced usage - prefer using create(SystemPolicyV1Beta1Settings).
Constructors
SystemPolicyV1Beta1Client(SystemPolicyV1Beta1Settings settings)
protectedSystemPolicyV1Beta1Client(SystemPolicyV1Beta1Settingssettings)Constructs an instance of SystemPolicyV1Beta1Client, 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.
SystemPolicyV1Beta1Client(SystemPolicyV1Beta1Stub stub)
protectedSystemPolicyV1Beta1Client(SystemPolicyV1Beta1Stubstub)Methods
awaitTermination(long duration, TimeUnit unit)
publicbooleanawaitTermination(longduration,TimeUnitunit)close()
publicfinalvoidclose()getSettings()
publicfinalSystemPolicyV1Beta1SettingsgetSettings()getStub()
publicSystemPolicyV1Beta1StubgetStub()getSystemPolicy(GetSystemPolicyRequest request)
publicfinalPolicygetSystemPolicy(GetSystemPolicyRequestrequest)Gets the current system policy in the specified 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(SystemPolicyV1Beta1ClientsystemPolicyV1Beta1Client=SystemPolicyV1Beta1Client.create()){
GetSystemPolicyRequestrequest=
GetSystemPolicyRequest.newBuilder()
.setName(PolicyName.ofLocationName("[LOCATION]").toString())
.build();
Policyresponse=systemPolicyV1Beta1Client.getSystemPolicy(request);
}
request
GetSystemPolicyRequest The request object containing all of the parameters for the API call.
getSystemPolicy(PolicyName name)
publicfinalPolicygetSystemPolicy(PolicyNamename)Gets the current system policy in the specified 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(SystemPolicyV1Beta1ClientsystemPolicyV1Beta1Client=SystemPolicyV1Beta1Client.create()){
PolicyNamename=PolicyName.ofLocationName("[LOCATION]");
Policyresponse=systemPolicyV1Beta1Client.getSystemPolicy(name);
}
name
PolicyName Required. The resource name, in the format locations/*/policy. Note that the
system policy is not associated with a project.
getSystemPolicy(String name)
publicfinalPolicygetSystemPolicy(Stringname)Gets the current system policy in the specified 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(SystemPolicyV1Beta1ClientsystemPolicyV1Beta1Client=SystemPolicyV1Beta1Client.create()){
Stringname=PolicyName.ofProjectName("[PROJECT]").toString();
Policyresponse=systemPolicyV1Beta1Client.getSystemPolicy(name);
}
name
String Required. The resource name, in the format locations/*/policy. Note that the
system policy is not associated with a project.
getSystemPolicyCallable()
publicfinalUnaryCallable<GetSystemPolicyRequest,Policy>getSystemPolicyCallable()Gets the current system policy in the specified 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(SystemPolicyV1Beta1ClientsystemPolicyV1Beta1Client=SystemPolicyV1Beta1Client.create()){
GetSystemPolicyRequestrequest=
GetSystemPolicyRequest.newBuilder()
.setName(PolicyName.ofLocationName("[LOCATION]").toString())
.build();
ApiFuture<Policy>future=
systemPolicyV1Beta1Client.getSystemPolicyCallable().futureCall(request);
// Do something.
Policyresponse=future.get();
}
isShutdown()
publicbooleanisShutdown()isTerminated()
publicbooleanisTerminated()shutdown()
publicvoidshutdown()shutdownNow()
publicvoidshutdownNow()