GitHub Repository | Product Reference |
Service Description: Service describing handlers for 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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
WorkloadName name =
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
Workload response = cloudControlsPartnerCoreClient.getWorkload(name);
}
Note: close() needs to be called on the CloudControlsPartnerCoreClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
GetWorkload | Gets details of a single workload |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListWorkloads | Lists customer workloads for a given customer org id |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetCustomer | Gets details of a single customer |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListCustomers | Lists customers of a partner identified by its Google Cloud organization ID |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetEkmConnections | Gets the EKM connections associated with a workload |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetPartnerPermissions | Gets the partner permissions granted for a workload |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListAccessApprovalRequests | Lists access requests associated with a workload |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetPartner | Get details of a Partner. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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 CloudControlsPartnerCoreSettings 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
CloudControlsPartnerCoreSettings cloudControlsPartnerCoreSettings =
CloudControlsPartnerCoreSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create(cloudControlsPartnerCoreSettings);
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
CloudControlsPartnerCoreSettings cloudControlsPartnerCoreSettings =
CloudControlsPartnerCoreSettings.newBuilder().setEndpoint(myEndpoint).build();
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create(cloudControlsPartnerCoreSettings);
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
CloudControlsPartnerCoreSettings cloudControlsPartnerCoreSettings =
CloudControlsPartnerCoreSettings.newHttpJsonBuilder().build();
CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create(cloudControlsPartnerCoreSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final CloudControlsPartnerCoreClient create()
Constructs an instance of CloudControlsPartnerCoreClient with default settings.
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(CloudControlsPartnerCoreSettings settings)
public static final CloudControlsPartnerCoreClient create(CloudControlsPartnerCoreSettings settings)
Constructs an instance of CloudControlsPartnerCoreClient, 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 | CloudControlsPartnerCoreSettings |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(CloudControlsPartnerCoreStub stub)
public static final CloudControlsPartnerCoreClient create(CloudControlsPartnerCoreStub stub)
Constructs an instance of CloudControlsPartnerCoreClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudControlsPartnerCoreSettings).
Parameter | |
---|---|
Name | Description |
stub | CloudControlsPartnerCoreStub |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient |
Constructors
CloudControlsPartnerCoreClient(CloudControlsPartnerCoreSettings settings)
protected CloudControlsPartnerCoreClient(CloudControlsPartnerCoreSettings settings)
Constructs an instance of CloudControlsPartnerCoreClient, 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 | CloudControlsPartnerCoreSettings |
CloudControlsPartnerCoreClient(CloudControlsPartnerCoreStub stub)
protected CloudControlsPartnerCoreClient(CloudControlsPartnerCoreStub stub)
Parameter | |
---|---|
Name | Description |
stub | CloudControlsPartnerCoreStub |
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()
getCustomer(CustomerName name)
public final Customer getCustomer(CustomerName name)
Gets details of a single customer
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
CustomerName name = CustomerName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]");
Customer response = cloudControlsPartnerCoreClient.getCustomer(name);
}
Parameter | |
---|---|
Name | Description |
name | CustomerName Required. Format: organizations/{organization}/locations/{location}/customers/{customer} |
Returns | |
---|---|
Type | Description |
Customer |
getCustomer(GetCustomerRequest request)
public final Customer getCustomer(GetCustomerRequest request)
Gets details of a single customer
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetCustomerRequest request =
GetCustomerRequest.newBuilder()
.setName(CustomerName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]").toString())
.build();
Customer response = cloudControlsPartnerCoreClient.getCustomer(request);
}
Parameter | |
---|---|
Name | Description |
request | GetCustomerRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Customer |
getCustomer(String name)
public final Customer getCustomer(String name)
Gets details of a single customer
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
String name = CustomerName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]").toString();
Customer response = cloudControlsPartnerCoreClient.getCustomer(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. Format: organizations/{organization}/locations/{location}/customers/{customer} |
Returns | |
---|---|
Type | Description |
Customer |
getCustomerCallable()
public final UnaryCallable<GetCustomerRequest,Customer> getCustomerCallable()
Gets details of a single customer
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetCustomerRequest request =
GetCustomerRequest.newBuilder()
.setName(CustomerName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]").toString())
.build();
ApiFuture<Customer> future =
cloudControlsPartnerCoreClient.getCustomerCallable().futureCall(request);
// Do something.
Customer response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetCustomerRequest,Customer> |
getEkmConnections(EkmConnectionsName name)
public final EkmConnections getEkmConnections(EkmConnectionsName name)
Gets the EKM connections associated with a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
EkmConnectionsName name =
EkmConnectionsName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
EkmConnections response = cloudControlsPartnerCoreClient.getEkmConnections(name);
}
Parameter | |
---|---|
Name | Description |
name | EkmConnectionsName Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections |
Returns | |
---|---|
Type | Description |
EkmConnections |
getEkmConnections(GetEkmConnectionsRequest request)
public final EkmConnections getEkmConnections(GetEkmConnectionsRequest request)
Gets the EKM connections associated with a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetEkmConnectionsRequest request =
GetEkmConnectionsRequest.newBuilder()
.setName(
EkmConnectionsName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString())
.build();
EkmConnections response = cloudControlsPartnerCoreClient.getEkmConnections(request);
}
Parameter | |
---|---|
Name | Description |
request | GetEkmConnectionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
EkmConnections |
getEkmConnections(String name)
public final EkmConnections getEkmConnections(String name)
Gets the EKM connections associated with a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
String name =
EkmConnectionsName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString();
EkmConnections response = cloudControlsPartnerCoreClient.getEkmConnections(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections |
Returns | |
---|---|
Type | Description |
EkmConnections |
getEkmConnectionsCallable()
public final UnaryCallable<GetEkmConnectionsRequest,EkmConnections> getEkmConnectionsCallable()
Gets the EKM connections associated with a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetEkmConnectionsRequest request =
GetEkmConnectionsRequest.newBuilder()
.setName(
EkmConnectionsName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString())
.build();
ApiFuture<EkmConnections> future =
cloudControlsPartnerCoreClient.getEkmConnectionsCallable().futureCall(request);
// Do something.
EkmConnections response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetEkmConnectionsRequest,EkmConnections> |
getPartner(GetPartnerRequest request)
public final Partner getPartner(GetPartnerRequest request)
Get details of a Partner.
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetPartnerRequest request =
GetPartnerRequest.newBuilder()
.setName(PartnerName.of("[ORGANIZATION]", "[LOCATION]").toString())
.build();
Partner response = cloudControlsPartnerCoreClient.getPartner(request);
}
Parameter | |
---|---|
Name | Description |
request | GetPartnerRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Partner |
getPartner(PartnerName name)
public final Partner getPartner(PartnerName name)
Get details of a Partner.
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
PartnerName name = PartnerName.of("[ORGANIZATION]", "[LOCATION]");
Partner response = cloudControlsPartnerCoreClient.getPartner(name);
}
Parameter | |
---|---|
Name | Description |
name | PartnerName Required. Format: organizations/{organization}/locations/{location}/partner |
Returns | |
---|---|
Type | Description |
Partner |
getPartner(String name)
public final Partner getPartner(String name)
Get details of a Partner.
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
String name = PartnerName.of("[ORGANIZATION]", "[LOCATION]").toString();
Partner response = cloudControlsPartnerCoreClient.getPartner(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. Format: organizations/{organization}/locations/{location}/partner |
Returns | |
---|---|
Type | Description |
Partner |
getPartnerCallable()
public final UnaryCallable<GetPartnerRequest,Partner> getPartnerCallable()
Get details of a Partner.
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetPartnerRequest request =
GetPartnerRequest.newBuilder()
.setName(PartnerName.of("[ORGANIZATION]", "[LOCATION]").toString())
.build();
ApiFuture<Partner> future =
cloudControlsPartnerCoreClient.getPartnerCallable().futureCall(request);
// Do something.
Partner response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetPartnerRequest,Partner> |
getPartnerPermissions(GetPartnerPermissionsRequest request)
public final PartnerPermissions getPartnerPermissions(GetPartnerPermissionsRequest request)
Gets the partner permissions granted for a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetPartnerPermissionsRequest request =
GetPartnerPermissionsRequest.newBuilder()
.setName(
PartnerPermissionsName.of(
"[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString())
.build();
PartnerPermissions response = cloudControlsPartnerCoreClient.getPartnerPermissions(request);
}
Parameter | |
---|---|
Name | Description |
request | GetPartnerPermissionsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
PartnerPermissions |
getPartnerPermissions(PartnerPermissionsName name)
public final PartnerPermissions getPartnerPermissions(PartnerPermissionsName name)
Gets the partner permissions granted for a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
PartnerPermissionsName name =
PartnerPermissionsName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
PartnerPermissions response = cloudControlsPartnerCoreClient.getPartnerPermissions(name);
}
Parameter | |
---|---|
Name | Description |
name | PartnerPermissionsName Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions |
Returns | |
---|---|
Type | Description |
PartnerPermissions |
getPartnerPermissions(String name)
public final PartnerPermissions getPartnerPermissions(String name)
Gets the partner permissions granted for a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
String name =
PartnerPermissionsName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString();
PartnerPermissions response = cloudControlsPartnerCoreClient.getPartnerPermissions(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. Name of the resource to get in the format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions |
Returns | |
---|---|
Type | Description |
PartnerPermissions |
getPartnerPermissionsCallable()
public final UnaryCallable<GetPartnerPermissionsRequest,PartnerPermissions> getPartnerPermissionsCallable()
Gets the partner permissions granted for a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetPartnerPermissionsRequest request =
GetPartnerPermissionsRequest.newBuilder()
.setName(
PartnerPermissionsName.of(
"[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString())
.build();
ApiFuture<PartnerPermissions> future =
cloudControlsPartnerCoreClient.getPartnerPermissionsCallable().futureCall(request);
// Do something.
PartnerPermissions response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetPartnerPermissionsRequest,PartnerPermissions> |
getSettings()
public final CloudControlsPartnerCoreSettings getSettings()
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreSettings |
getStub()
public CloudControlsPartnerCoreStub getStub()
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreStub |
getWorkload(GetWorkloadRequest request)
public final Workload getWorkload(GetWorkloadRequest request)
Gets details of a single workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetWorkloadRequest request =
GetWorkloadRequest.newBuilder()
.setName(
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString())
.build();
Workload response = cloudControlsPartnerCoreClient.getWorkload(request);
}
Parameter | |
---|---|
Name | Description |
request | GetWorkloadRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Workload |
getWorkload(WorkloadName name)
public final Workload getWorkload(WorkloadName name)
Gets details of a single workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
WorkloadName name =
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
Workload response = cloudControlsPartnerCoreClient.getWorkload(name);
}
Parameter | |
---|---|
Name | Description |
name | WorkloadName Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload} |
Returns | |
---|---|
Type | Description |
Workload |
getWorkload(String name)
public final Workload getWorkload(String name)
Gets details of a single workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
String name =
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]").toString();
Workload response = cloudControlsPartnerCoreClient.getWorkload(name);
}
Parameter | |
---|---|
Name | Description |
name | String Required. Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload} |
Returns | |
---|---|
Type | Description |
Workload |
getWorkloadCallable()
public final UnaryCallable<GetWorkloadRequest,Workload> getWorkloadCallable()
Gets details of a single workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
GetWorkloadRequest request =
GetWorkloadRequest.newBuilder()
.setName(
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString())
.build();
ApiFuture<Workload> future =
cloudControlsPartnerCoreClient.getWorkloadCallable().futureCall(request);
// Do something.
Workload response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<GetWorkloadRequest,Workload> |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
listAccessApprovalRequests(ListAccessApprovalRequestsRequest request)
public final CloudControlsPartnerCoreClient.ListAccessApprovalRequestsPagedResponse listAccessApprovalRequests(ListAccessApprovalRequestsRequest request)
Lists access requests associated with a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
ListAccessApprovalRequestsRequest request =
ListAccessApprovalRequestsRequest.newBuilder()
.setParent(
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (AccessApprovalRequest element :
cloudControlsPartnerCoreClient.listAccessApprovalRequests(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListAccessApprovalRequestsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient.ListAccessApprovalRequestsPagedResponse |
listAccessApprovalRequests(WorkloadName parent)
public final CloudControlsPartnerCoreClient.ListAccessApprovalRequestsPagedResponse listAccessApprovalRequests(WorkloadName parent)
Lists access requests associated with a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
WorkloadName parent =
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]");
for (AccessApprovalRequest element :
cloudControlsPartnerCoreClient.listAccessApprovalRequests(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | WorkloadName Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload} |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient.ListAccessApprovalRequestsPagedResponse |
listAccessApprovalRequests(String parent)
public final CloudControlsPartnerCoreClient.ListAccessApprovalRequestsPagedResponse listAccessApprovalRequests(String parent)
Lists access requests associated with a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
String parent =
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]").toString();
for (AccessApprovalRequest element :
cloudControlsPartnerCoreClient.listAccessApprovalRequests(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload} |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient.ListAccessApprovalRequestsPagedResponse |
listAccessApprovalRequestsCallable()
public final UnaryCallable<ListAccessApprovalRequestsRequest,ListAccessApprovalRequestsResponse> listAccessApprovalRequestsCallable()
Lists access requests associated with a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
ListAccessApprovalRequestsRequest request =
ListAccessApprovalRequestsRequest.newBuilder()
.setParent(
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListAccessApprovalRequestsResponse response =
cloudControlsPartnerCoreClient.listAccessApprovalRequestsCallable().call(request);
for (AccessApprovalRequest element : response.getAccessApprovalRequestsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListAccessApprovalRequestsRequest,ListAccessApprovalRequestsResponse> |
listAccessApprovalRequestsPagedCallable()
public final UnaryCallable<ListAccessApprovalRequestsRequest,CloudControlsPartnerCoreClient.ListAccessApprovalRequestsPagedResponse> listAccessApprovalRequestsPagedCallable()
Lists access requests associated with a workload
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
ListAccessApprovalRequestsRequest request =
ListAccessApprovalRequestsRequest.newBuilder()
.setParent(
WorkloadName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]", "[WORKLOAD]")
.toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<AccessApprovalRequest> future =
cloudControlsPartnerCoreClient
.listAccessApprovalRequestsPagedCallable()
.futureCall(request);
// Do something.
for (AccessApprovalRequest element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListAccessApprovalRequestsRequest,ListAccessApprovalRequestsPagedResponse> |
listCustomers(ListCustomersRequest request)
public final CloudControlsPartnerCoreClient.ListCustomersPagedResponse listCustomers(ListCustomersRequest request)
Lists customers of a partner identified by its Google Cloud organization ID
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
ListCustomersRequest request =
ListCustomersRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Customer element : cloudControlsPartnerCoreClient.listCustomers(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListCustomersRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient.ListCustomersPagedResponse |
listCustomers(OrganizationLocationName parent)
public final CloudControlsPartnerCoreClient.ListCustomersPagedResponse listCustomers(OrganizationLocationName parent)
Lists customers of a partner identified by its Google Cloud organization ID
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
OrganizationLocationName parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]");
for (Customer element : cloudControlsPartnerCoreClient.listCustomers(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | OrganizationLocationName Required. Parent resource Format: organizations/{organization}/locations/{location} |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient.ListCustomersPagedResponse |
listCustomers(String parent)
public final CloudControlsPartnerCoreClient.ListCustomersPagedResponse listCustomers(String parent)
Lists customers of a partner identified by its Google Cloud organization ID
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
String parent = OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString();
for (Customer element : cloudControlsPartnerCoreClient.listCustomers(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. Parent resource Format: organizations/{organization}/locations/{location} |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient.ListCustomersPagedResponse |
listCustomersCallable()
public final UnaryCallable<ListCustomersRequest,ListCustomersResponse> listCustomersCallable()
Lists customers of a partner identified by its Google Cloud organization ID
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
ListCustomersRequest request =
ListCustomersRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListCustomersResponse response =
cloudControlsPartnerCoreClient.listCustomersCallable().call(request);
for (Customer element : response.getCustomersList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListCustomersRequest,ListCustomersResponse> |
listCustomersPagedCallable()
public final UnaryCallable<ListCustomersRequest,CloudControlsPartnerCoreClient.ListCustomersPagedResponse> listCustomersPagedCallable()
Lists customers of a partner identified by its Google Cloud organization ID
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
ListCustomersRequest request =
ListCustomersRequest.newBuilder()
.setParent(OrganizationLocationName.of("[ORGANIZATION]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Customer> future =
cloudControlsPartnerCoreClient.listCustomersPagedCallable().futureCall(request);
// Do something.
for (Customer element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListCustomersRequest,ListCustomersPagedResponse> |
listWorkloads(CustomerName parent)
public final CloudControlsPartnerCoreClient.ListWorkloadsPagedResponse listWorkloads(CustomerName parent)
Lists customer workloads for a given customer org id
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
CustomerName parent = CustomerName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]");
for (Workload element : cloudControlsPartnerCoreClient.listWorkloads(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | CustomerName Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer} |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient.ListWorkloadsPagedResponse |
listWorkloads(ListWorkloadsRequest request)
public final CloudControlsPartnerCoreClient.ListWorkloadsPagedResponse listWorkloads(ListWorkloadsRequest request)
Lists customer workloads for a given customer org id
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
ListWorkloadsRequest request =
ListWorkloadsRequest.newBuilder()
.setParent(CustomerName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Workload element : cloudControlsPartnerCoreClient.listWorkloads(request).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
request | ListWorkloadsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient.ListWorkloadsPagedResponse |
listWorkloads(String parent)
public final CloudControlsPartnerCoreClient.ListWorkloadsPagedResponse listWorkloads(String parent)
Lists customer workloads for a given customer org id
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
String parent = CustomerName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]").toString();
for (Workload element : cloudControlsPartnerCoreClient.listWorkloads(parent).iterateAll()) {
// doThingsWith(element);
}
}
Parameter | |
---|---|
Name | Description |
parent | String Required. Parent resource Format: organizations/{organization}/locations/{location}/customers/{customer} |
Returns | |
---|---|
Type | Description |
CloudControlsPartnerCoreClient.ListWorkloadsPagedResponse |
listWorkloadsCallable()
public final UnaryCallable<ListWorkloadsRequest,ListWorkloadsResponse> listWorkloadsCallable()
Lists customer workloads for a given customer org id
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
ListWorkloadsRequest request =
ListWorkloadsRequest.newBuilder()
.setParent(CustomerName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListWorkloadsResponse response =
cloudControlsPartnerCoreClient.listWorkloadsCallable().call(request);
for (Workload element : response.getWorkloadsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListWorkloadsRequest,ListWorkloadsResponse> |
listWorkloadsPagedCallable()
public final UnaryCallable<ListWorkloadsRequest,CloudControlsPartnerCoreClient.ListWorkloadsPagedResponse> listWorkloadsPagedCallable()
Lists customer workloads for a given customer org id
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 (CloudControlsPartnerCoreClient cloudControlsPartnerCoreClient =
CloudControlsPartnerCoreClient.create()) {
ListWorkloadsRequest request =
ListWorkloadsRequest.newBuilder()
.setParent(CustomerName.of("[ORGANIZATION]", "[LOCATION]", "[CUSTOMER]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Workload> future =
cloudControlsPartnerCoreClient.listWorkloadsPagedCallable().futureCall(request);
// Do something.
for (Workload element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ListWorkloadsRequest,ListWorkloadsPagedResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()