Class ServiceManagerClient
- java.lang.Object
-
- com.google.cloud.api.servicemanagement.v1.ServiceManagerClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class ServiceManagerClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: [Google Service Management API](https://cloud.google.com/service-infrastructure/docs/overview)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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; ManagedService response = serviceManagerClient.getService(serviceName); }
Note: close() needs to be called on the ServiceManagerClient 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 ServiceManagerSettings 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 ServiceManagerSettings serviceManagerSettings = ServiceManagerSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); ServiceManagerClient serviceManagerClient = ServiceManagerClient.create(serviceManagerSettings);
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 ServiceManagerSettings serviceManagerSettings = ServiceManagerSettings.newBuilder().setEndpoint(myEndpoint).build(); ServiceManagerClient serviceManagerClient = ServiceManagerClient.create(serviceManagerSettings);
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 ServiceManagerSettings serviceManagerSettings = ServiceManagerSettings.newHttpJsonBuilder().build(); ServiceManagerClient serviceManagerClient = ServiceManagerClient.create(serviceManagerSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ServiceManagerClient.ListServiceConfigsFixedSizeCollection
static class
ServiceManagerClient.ListServiceConfigsPage
static class
ServiceManagerClient.ListServiceConfigsPagedResponse
static class
ServiceManagerClient.ListServiceRolloutsFixedSizeCollection
static class
ServiceManagerClient.ListServiceRolloutsPage
static class
ServiceManagerClient.ListServiceRolloutsPagedResponse
static class
ServiceManagerClient.ListServicesFixedSizeCollection
static class
ServiceManagerClient.ListServicesPage
static class
ServiceManagerClient.ListServicesPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
ServiceManagerClient(ServiceManagerSettings settings)
Constructs an instance of ServiceManagerClient, using the given settings.protected
ServiceManagerClient(ServiceManagerStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static ServiceManagerClient
create()
Constructs an instance of ServiceManagerClient with default settings.static ServiceManagerClient
create(ServiceManagerSettings settings)
Constructs an instance of ServiceManagerClient, using the given settings.static ServiceManagerClient
create(ServiceManagerStub stub)
Constructs an instance of ServiceManagerClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<ManagedService,OperationMetadata>
createServiceAsync(CreateServiceRequest request)
Creates a new managed service.com.google.api.gax.longrunning.OperationFuture<ManagedService,OperationMetadata>
createServiceAsync(ManagedService service)
Creates a new managed service.com.google.api.gax.rpc.UnaryCallable<CreateServiceRequest,com.google.longrunning.Operation>
createServiceCallable()
Creates a new managed service.com.google.api.Service
createServiceConfig(CreateServiceConfigRequest request)
Creates a new service configuration (version) for a managed service.com.google.api.Service
createServiceConfig(String serviceName, com.google.api.Service serviceConfig)
Creates a new service configuration (version) for a managed service.com.google.api.gax.rpc.UnaryCallable<CreateServiceConfigRequest,com.google.api.Service>
createServiceConfigCallable()
Creates a new service configuration (version) for a managed service.com.google.api.gax.rpc.OperationCallable<CreateServiceRequest,ManagedService,OperationMetadata>
createServiceOperationCallable()
Creates a new managed service.com.google.api.gax.longrunning.OperationFuture<Rollout,OperationMetadata>
createServiceRolloutAsync(CreateServiceRolloutRequest request)
Creates a new service configuration rollout.com.google.api.gax.longrunning.OperationFuture<Rollout,OperationMetadata>
createServiceRolloutAsync(String serviceName, Rollout rollout)
Creates a new service configuration rollout.com.google.api.gax.rpc.UnaryCallable<CreateServiceRolloutRequest,com.google.longrunning.Operation>
createServiceRolloutCallable()
Creates a new service configuration rollout.com.google.api.gax.rpc.OperationCallable<CreateServiceRolloutRequest,Rollout,OperationMetadata>
createServiceRolloutOperationCallable()
Creates a new service configuration rollout.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteServiceAsync(DeleteServiceRequest request)
Deletes a managed service.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteServiceAsync(String serviceName)
Deletes a managed service.com.google.api.gax.rpc.UnaryCallable<DeleteServiceRequest,com.google.longrunning.Operation>
deleteServiceCallable()
Deletes a managed service.com.google.api.gax.rpc.OperationCallable<DeleteServiceRequest,com.google.protobuf.Empty,OperationMetadata>
deleteServiceOperationCallable()
Deletes a managed service.GenerateConfigReportResponse
generateConfigReport(GenerateConfigReportRequest request)
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_valueGenerateConfigReportResponse
generateConfigReport(com.google.protobuf.Any newConfig, com.google.protobuf.Any oldConfig)
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_valuecom.google.api.gax.rpc.UnaryCallable<GenerateConfigReportRequest,GenerateConfigReportResponse>
generateConfigReportCallable()
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_valuecom.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.iam.v1.Policy
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for a resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicyCallable()
Gets the access control policy for a resource.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.ManagedService
getService(GetServiceRequest request)
Gets a managed service.ManagedService
getService(String serviceName)
Gets a managed service.com.google.api.gax.rpc.UnaryCallable<GetServiceRequest,ManagedService>
getServiceCallable()
Gets a managed service.com.google.api.Service
getServiceConfig(GetServiceConfigRequest request)
Gets a service configuration (version) for a managed service.com.google.api.Service
getServiceConfig(String serviceName, String configId, GetServiceConfigRequest.ConfigView view)
Gets a service configuration (version) for a managed service.com.google.api.gax.rpc.UnaryCallable<GetServiceConfigRequest,com.google.api.Service>
getServiceConfigCallable()
Gets a service configuration (version) for a managed service.Rollout
getServiceRollout(GetServiceRolloutRequest request)
Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].Rollout
getServiceRollout(String serviceName, String rolloutId)
Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].com.google.api.gax.rpc.UnaryCallable<GetServiceRolloutRequest,Rollout>
getServiceRolloutCallable()
Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].ServiceManagerSettings
getSettings()
ServiceManagerStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
ServiceManagerClient.ListServiceConfigsPagedResponse
listServiceConfigs(ListServiceConfigsRequest request)
Lists the history of the service configuration for a managed service, from the newest to the oldest.ServiceManagerClient.ListServiceConfigsPagedResponse
listServiceConfigs(String serviceName)
Lists the history of the service configuration for a managed service, from the newest to the oldest.com.google.api.gax.rpc.UnaryCallable<ListServiceConfigsRequest,ListServiceConfigsResponse>
listServiceConfigsCallable()
Lists the history of the service configuration for a managed service, from the newest to the oldest.com.google.api.gax.rpc.UnaryCallable<ListServiceConfigsRequest,ServiceManagerClient.ListServiceConfigsPagedResponse>
listServiceConfigsPagedCallable()
Lists the history of the service configuration for a managed service, from the newest to the oldest.ServiceManagerClient.ListServiceRolloutsPagedResponse
listServiceRollouts(ListServiceRolloutsRequest request)
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.ServiceManagerClient.ListServiceRolloutsPagedResponse
listServiceRollouts(String serviceName, String filter)
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.com.google.api.gax.rpc.UnaryCallable<ListServiceRolloutsRequest,ListServiceRolloutsResponse>
listServiceRolloutsCallable()
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.com.google.api.gax.rpc.UnaryCallable<ListServiceRolloutsRequest,ServiceManagerClient.ListServiceRolloutsPagedResponse>
listServiceRolloutsPagedCallable()
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.ServiceManagerClient.ListServicesPagedResponse
listServices(ListServicesRequest request)
Lists managed services.ServiceManagerClient.ListServicesPagedResponse
listServices(String producerProjectId, String consumerId)
Lists managed services.com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,ListServicesResponse>
listServicesCallable()
Lists managed services.com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,ServiceManagerClient.ListServicesPagedResponse>
listServicesPagedCallable()
Lists managed services.com.google.iam.v1.Policy
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicyCallable()
Sets the access control policy on the specified resource.void
shutdown()
void
shutdownNow()
com.google.api.gax.longrunning.OperationFuture<SubmitConfigSourceResponse,OperationMetadata>
submitConfigSourceAsync(SubmitConfigSourceRequest request)
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification).com.google.api.gax.longrunning.OperationFuture<SubmitConfigSourceResponse,OperationMetadata>
submitConfigSourceAsync(String serviceName, ConfigSource configSource, boolean validateOnly)
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification).com.google.api.gax.rpc.UnaryCallable<SubmitConfigSourceRequest,com.google.longrunning.Operation>
submitConfigSourceCallable()
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification).com.google.api.gax.rpc.OperationCallable<SubmitConfigSourceRequest,SubmitConfigSourceResponse,OperationMetadata>
submitConfigSourceOperationCallable()
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification).com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.com.google.api.gax.longrunning.OperationFuture<UndeleteServiceResponse,OperationMetadata>
undeleteServiceAsync(UndeleteServiceRequest request)
Revives a previously deleted managed service.com.google.api.gax.longrunning.OperationFuture<UndeleteServiceResponse,OperationMetadata>
undeleteServiceAsync(String serviceName)
Revives a previously deleted managed service.com.google.api.gax.rpc.UnaryCallable<UndeleteServiceRequest,com.google.longrunning.Operation>
undeleteServiceCallable()
Revives a previously deleted managed service.com.google.api.gax.rpc.OperationCallable<UndeleteServiceRequest,UndeleteServiceResponse,OperationMetadata>
undeleteServiceOperationCallable()
Revives a previously deleted managed service.
-
-
-
Constructor Detail
-
ServiceManagerClient
protected ServiceManagerClient(ServiceManagerSettings settings) throws IOException
Constructs an instance of ServiceManagerClient, 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.- Throws:
IOException
-
ServiceManagerClient
protected ServiceManagerClient(ServiceManagerStub stub)
-
-
Method Detail
-
create
public static final ServiceManagerClient create() throws IOException
Constructs an instance of ServiceManagerClient with default settings.- Throws:
IOException
-
create
public static final ServiceManagerClient create(ServiceManagerSettings settings) throws IOException
Constructs an instance of ServiceManagerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.- Throws:
IOException
-
create
public static final ServiceManagerClient create(ServiceManagerStub stub)
Constructs an instance of ServiceManagerClient, using the given stub for making calls. This is for advanced usage - prefer using create(ServiceManagerSettings).
-
getSettings
public final ServiceManagerSettings getSettings()
-
getStub
public ServiceManagerStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
listServices
public final ServiceManagerClient.ListServicesPagedResponse listServices(String producerProjectId, String consumerId)
Lists managed services.Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String producerProjectId = "producerProjectId-1297373534"; String consumerId = "consumerId-166238287"; for (ManagedService element : serviceManagerClient.listServices(producerProjectId, consumerId).iterateAll()) { // doThingsWith(element); } }
- Parameters:
producerProjectId
- Include services produced by the specified project.consumerId
- Include services consumed by the specified consumer.The Google Service Management implementation accepts the following forms: - project:<project_id>
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listServices
public final ServiceManagerClient.ListServicesPagedResponse listServices(ListServicesRequest request)
Lists managed services.Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ListServicesRequest request = ListServicesRequest.newBuilder() .setProducerProjectId("producerProjectId-1297373534") .setPageSize(883849137) .setPageToken("pageToken873572522") .setConsumerId("consumerId-166238287") .build(); for (ManagedService element : serviceManagerClient.listServices(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listServicesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,ServiceManagerClient.ListServicesPagedResponse> listServicesPagedCallable()
Lists managed services.Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ListServicesRequest request = ListServicesRequest.newBuilder() .setProducerProjectId("producerProjectId-1297373534") .setPageSize(883849137) .setPageToken("pageToken873572522") .setConsumerId("consumerId-166238287") .build(); ApiFuture<ManagedService> future = serviceManagerClient.listServicesPagedCallable().futureCall(request); // Do something. for (ManagedService element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listServicesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,ListServicesResponse> listServicesCallable()
Lists managed services.Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ListServicesRequest request = ListServicesRequest.newBuilder() .setProducerProjectId("producerProjectId-1297373534") .setPageSize(883849137) .setPageToken("pageToken873572522") .setConsumerId("consumerId-166238287") .build(); while (true) { ListServicesResponse response = serviceManagerClient.listServicesCallable().call(request); for (ManagedService element : response.getServicesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getService
public final ManagedService getService(String serviceName)
Gets a managed service. Authentication is required unless the service is public.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; ManagedService response = serviceManagerClient.getService(serviceName); }
- Parameters:
serviceName
- Required. The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getService
public final ManagedService getService(GetServiceRequest request)
Gets a managed service. Authentication is required unless the service is public.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GetServiceRequest request = GetServiceRequest.newBuilder().setServiceName("serviceName-1928572192").build(); ManagedService response = serviceManagerClient.getService(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getServiceCallable
public final com.google.api.gax.rpc.UnaryCallable<GetServiceRequest,ManagedService> getServiceCallable()
Gets a managed service. Authentication is required unless the service is public.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GetServiceRequest request = GetServiceRequest.newBuilder().setServiceName("serviceName-1928572192").build(); ApiFuture<ManagedService> future = serviceManagerClient.getServiceCallable().futureCall(request); // Do something. ManagedService response = future.get(); }
-
createServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<ManagedService,OperationMetadata> createServiceAsync(ManagedService service)
Creates a new managed service.A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion.
One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.
Operation<response: ManagedService>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ManagedService service = ManagedService.newBuilder().build(); ManagedService response = serviceManagerClient.createServiceAsync(service).get(); }
- Parameters:
service
- Required. Initial values for the service resource.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<ManagedService,OperationMetadata> createServiceAsync(CreateServiceRequest request)
Creates a new managed service.A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion.
One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.
Operation<response: ManagedService>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { CreateServiceRequest request = CreateServiceRequest.newBuilder().setService(ManagedService.newBuilder().build()).build(); ManagedService response = serviceManagerClient.createServiceAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createServiceOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CreateServiceRequest,ManagedService,OperationMetadata> createServiceOperationCallable()
Creates a new managed service.A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion.
One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.
Operation<response: ManagedService>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { CreateServiceRequest request = CreateServiceRequest.newBuilder().setService(ManagedService.newBuilder().build()).build(); OperationFuture<ManagedService, OperationMetadata> future = serviceManagerClient.createServiceOperationCallable().futureCall(request); // Do something. ManagedService response = future.get(); }
-
createServiceCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateServiceRequest,com.google.longrunning.Operation> createServiceCallable()
Creates a new managed service.A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion.
One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.
Operation<response: ManagedService>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { CreateServiceRequest request = CreateServiceRequest.newBuilder().setService(ManagedService.newBuilder().build()).build(); ApiFuture<Operation> future = serviceManagerClient.createServiceCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
deleteServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteServiceAsync(String serviceName)
Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService] to restore the service. After 30 days, the service will be permanently deleted.Operation<response: google.protobuf.Empty>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; serviceManagerClient.deleteServiceAsync(serviceName).get(); }
- Parameters:
serviceName
- Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteServiceAsync(DeleteServiceRequest request)
Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService] to restore the service. After 30 days, the service will be permanently deleted.Operation<response: google.protobuf.Empty>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { DeleteServiceRequest request = DeleteServiceRequest.newBuilder().setServiceName("serviceName-1928572192").build(); serviceManagerClient.deleteServiceAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteServiceOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteServiceRequest,com.google.protobuf.Empty,OperationMetadata> deleteServiceOperationCallable()
Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService] to restore the service. After 30 days, the service will be permanently deleted.Operation<response: google.protobuf.Empty>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { DeleteServiceRequest request = DeleteServiceRequest.newBuilder().setServiceName("serviceName-1928572192").build(); OperationFuture<Empty, OperationMetadata> future = serviceManagerClient.deleteServiceOperationCallable().futureCall(request); // Do something. future.get(); }
-
deleteServiceCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteServiceRequest,com.google.longrunning.Operation> deleteServiceCallable()
Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call [UndeleteService][google.api.servicemanagement.v1.ServiceManager.UndeleteService] to restore the service. After 30 days, the service will be permanently deleted.Operation<response: google.protobuf.Empty>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { DeleteServiceRequest request = DeleteServiceRequest.newBuilder().setServiceName("serviceName-1928572192").build(); ApiFuture<Operation> future = serviceManagerClient.deleteServiceCallable().futureCall(request); // Do something. future.get(); }
-
undeleteServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<UndeleteServiceResponse,OperationMetadata> undeleteServiceAsync(String serviceName)
Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.Operation<response: UndeleteServiceResponse>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; UndeleteServiceResponse response = serviceManagerClient.undeleteServiceAsync(serviceName).get(); }
- Parameters:
serviceName
- Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
undeleteServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<UndeleteServiceResponse,OperationMetadata> undeleteServiceAsync(UndeleteServiceRequest request)
Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.Operation<response: UndeleteServiceResponse>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { UndeleteServiceRequest request = UndeleteServiceRequest.newBuilder().setServiceName("serviceName-1928572192").build(); UndeleteServiceResponse response = serviceManagerClient.undeleteServiceAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
undeleteServiceOperationCallable
public final com.google.api.gax.rpc.OperationCallable<UndeleteServiceRequest,UndeleteServiceResponse,OperationMetadata> undeleteServiceOperationCallable()
Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.Operation<response: UndeleteServiceResponse>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { UndeleteServiceRequest request = UndeleteServiceRequest.newBuilder().setServiceName("serviceName-1928572192").build(); OperationFuture<UndeleteServiceResponse, OperationMetadata> future = serviceManagerClient.undeleteServiceOperationCallable().futureCall(request); // Do something. UndeleteServiceResponse response = future.get(); }
-
undeleteServiceCallable
public final com.google.api.gax.rpc.UnaryCallable<UndeleteServiceRequest,com.google.longrunning.Operation> undeleteServiceCallable()
Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must have been deleted within the last 30 days.Operation<response: UndeleteServiceResponse>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { UndeleteServiceRequest request = UndeleteServiceRequest.newBuilder().setServiceName("serviceName-1928572192").build(); ApiFuture<Operation> future = serviceManagerClient.undeleteServiceCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
listServiceConfigs
public final ServiceManagerClient.ListServiceConfigsPagedResponse listServiceConfigs(String serviceName)
Lists the history of the service configuration for a managed service, from the newest to the oldest.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; for (Service element : serviceManagerClient.listServiceConfigs(serviceName).iterateAll()) { // doThingsWith(element); } }
- Parameters:
serviceName
- Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listServiceConfigs
public final ServiceManagerClient.ListServiceConfigsPagedResponse listServiceConfigs(ListServiceConfigsRequest request)
Lists the history of the service configuration for a managed service, from the newest to the oldest.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ListServiceConfigsRequest request = ListServiceConfigsRequest.newBuilder() .setServiceName("serviceName-1928572192") .setPageToken("pageToken873572522") .setPageSize(883849137) .build(); for (Service element : serviceManagerClient.listServiceConfigs(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listServiceConfigsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListServiceConfigsRequest,ServiceManagerClient.ListServiceConfigsPagedResponse> listServiceConfigsPagedCallable()
Lists the history of the service configuration for a managed service, from the newest to the oldest.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ListServiceConfigsRequest request = ListServiceConfigsRequest.newBuilder() .setServiceName("serviceName-1928572192") .setPageToken("pageToken873572522") .setPageSize(883849137) .build(); ApiFuture<Service> future = serviceManagerClient.listServiceConfigsPagedCallable().futureCall(request); // Do something. for (Service element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listServiceConfigsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListServiceConfigsRequest,ListServiceConfigsResponse> listServiceConfigsCallable()
Lists the history of the service configuration for a managed service, from the newest to the oldest.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ListServiceConfigsRequest request = ListServiceConfigsRequest.newBuilder() .setServiceName("serviceName-1928572192") .setPageToken("pageToken873572522") .setPageSize(883849137) .build(); while (true) { ListServiceConfigsResponse response = serviceManagerClient.listServiceConfigsCallable().call(request); for (Service element : response.getServiceConfigsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getServiceConfig
public final com.google.api.Service getServiceConfig(String serviceName, String configId, GetServiceConfigRequest.ConfigView view)
Gets a service configuration (version) for a managed 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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; String configId = "configId-580140035"; GetServiceConfigRequest.ConfigView view = GetServiceConfigRequest.ConfigView.forNumber(0); Service response = serviceManagerClient.getServiceConfig(serviceName, configId, view); }
- Parameters:
serviceName
- Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`.configId
- Required. The id of the service configuration resource.This field must be specified for the server to return all fields, including `SourceInfo`.
view
- Specifies which parts of the Service Config should be returned in the response.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getServiceConfig
public final com.google.api.Service getServiceConfig(GetServiceConfigRequest request)
Gets a service configuration (version) for a managed 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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GetServiceConfigRequest request = GetServiceConfigRequest.newBuilder() .setServiceName("serviceName-1928572192") .setConfigId("configId-580140035") .build(); Service response = serviceManagerClient.getServiceConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getServiceConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<GetServiceConfigRequest,com.google.api.Service> getServiceConfigCallable()
Gets a service configuration (version) for a managed 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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GetServiceConfigRequest request = GetServiceConfigRequest.newBuilder() .setServiceName("serviceName-1928572192") .setConfigId("configId-580140035") .build(); ApiFuture<Service> future = serviceManagerClient.getServiceConfigCallable().futureCall(request); // Do something. Service response = future.get(); }
-
createServiceConfig
public final com.google.api.Service createServiceConfig(String serviceName, com.google.api.Service serviceConfig)
Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; Service serviceConfig = Service.newBuilder().build(); Service response = serviceManagerClient.createServiceConfig(serviceName, serviceConfig); }
- Parameters:
serviceName
- Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`.serviceConfig
- Required. The service configuration resource.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createServiceConfig
public final com.google.api.Service createServiceConfig(CreateServiceConfigRequest request)
Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { CreateServiceConfigRequest request = CreateServiceConfigRequest.newBuilder() .setServiceName("serviceName-1928572192") .setServiceConfig(Service.newBuilder().build()) .build(); Service response = serviceManagerClient.createServiceConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createServiceConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateServiceConfigRequest,com.google.api.Service> createServiceConfigCallable()
Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { CreateServiceConfigRequest request = CreateServiceConfigRequest.newBuilder() .setServiceName("serviceName-1928572192") .setServiceConfig(Service.newBuilder().build()) .build(); ApiFuture<Service> future = serviceManagerClient.createServiceConfigCallable().futureCall(request); // Do something. Service response = future.get(); }
-
submitConfigSourceAsync
public final com.google.api.gax.longrunning.OperationFuture<SubmitConfigSourceResponse,OperationMetadata> submitConfigSourceAsync(String serviceName, ConfigSource configSource, boolean validateOnly)
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.
Operation<response: SubmitConfigSourceResponse>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; ConfigSource configSource = ConfigSource.newBuilder().build(); boolean validateOnly = true; SubmitConfigSourceResponse response = serviceManagerClient .submitConfigSourceAsync(serviceName, configSource, validateOnly) .get(); }
- Parameters:
serviceName
- Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`.configSource
- Required. The source configuration for the service.validateOnly
- Optional. If set, this will result in the generation of a `google.api.Service` configuration based on the `ConfigSource` provided, but the generated config and the sources will NOT be persisted.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
submitConfigSourceAsync
public final com.google.api.gax.longrunning.OperationFuture<SubmitConfigSourceResponse,OperationMetadata> submitConfigSourceAsync(SubmitConfigSourceRequest request)
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.
Operation<response: SubmitConfigSourceResponse>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { SubmitConfigSourceRequest request = SubmitConfigSourceRequest.newBuilder() .setServiceName("serviceName-1928572192") .setConfigSource(ConfigSource.newBuilder().build()) .setValidateOnly(true) .build(); SubmitConfigSourceResponse response = serviceManagerClient.submitConfigSourceAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
submitConfigSourceOperationCallable
public final com.google.api.gax.rpc.OperationCallable<SubmitConfigSourceRequest,SubmitConfigSourceResponse,OperationMetadata> submitConfigSourceOperationCallable()
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.
Operation<response: SubmitConfigSourceResponse>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { SubmitConfigSourceRequest request = SubmitConfigSourceRequest.newBuilder() .setServiceName("serviceName-1928572192") .setConfigSource(ConfigSource.newBuilder().build()) .setValidateOnly(true) .build(); OperationFuture<SubmitConfigSourceResponse, OperationMetadata> future = serviceManagerClient.submitConfigSourceOperationCallable().futureCall(request); // Do something. SubmitConfigSourceResponse response = future.get(); }
-
submitConfigSourceCallable
public final com.google.api.gax.rpc.UnaryCallable<SubmitConfigSourceRequest,com.google.longrunning.Operation> submitConfigSourceCallable()
Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call [CreateServiceRollout][google.api.servicemanagement.v1.ServiceManager.CreateServiceRollout].Only the 100 most recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually.
Operation<response: SubmitConfigSourceResponse>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { SubmitConfigSourceRequest request = SubmitConfigSourceRequest.newBuilder() .setServiceName("serviceName-1928572192") .setConfigSource(ConfigSource.newBuilder().build()) .setValidateOnly(true) .build(); ApiFuture<Operation> future = serviceManagerClient.submitConfigSourceCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
listServiceRollouts
public final ServiceManagerClient.ListServiceRolloutsPagedResponse listServiceRollouts(String serviceName, String filter)
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; String filter = "filter-1274492040"; for (Rollout element : serviceManagerClient.listServiceRollouts(serviceName, filter).iterateAll()) { // doThingsWith(element); } }
- Parameters:
serviceName
- Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`.filter
- Required. Use `filter` to return subset of rollouts. The following filters are supported:-- By [status] [google.api.servicemanagement.v1.Rollout.RolloutStatus]. For example, `filter='status=SUCCESS'`
-- By [strategy] [google.api.servicemanagement.v1.Rollout.strategy]. For example, `filter='strategy=TrafficPercentStrategy'`
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listServiceRollouts
public final ServiceManagerClient.ListServiceRolloutsPagedResponse listServiceRollouts(ListServiceRolloutsRequest request)
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ListServiceRolloutsRequest request = ListServiceRolloutsRequest.newBuilder() .setServiceName("serviceName-1928572192") .setPageToken("pageToken873572522") .setPageSize(883849137) .setFilter("filter-1274492040") .build(); for (Rollout element : serviceManagerClient.listServiceRollouts(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listServiceRolloutsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListServiceRolloutsRequest,ServiceManagerClient.ListServiceRolloutsPagedResponse> listServiceRolloutsPagedCallable()
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ListServiceRolloutsRequest request = ListServiceRolloutsRequest.newBuilder() .setServiceName("serviceName-1928572192") .setPageToken("pageToken873572522") .setPageSize(883849137) .setFilter("filter-1274492040") .build(); ApiFuture<Rollout> future = serviceManagerClient.listServiceRolloutsPagedCallable().futureCall(request); // Do something. for (Rollout element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listServiceRolloutsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListServiceRolloutsRequest,ListServiceRolloutsResponse> listServiceRolloutsCallable()
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { ListServiceRolloutsRequest request = ListServiceRolloutsRequest.newBuilder() .setServiceName("serviceName-1928572192") .setPageToken("pageToken873572522") .setPageSize(883849137) .setFilter("filter-1274492040") .build(); while (true) { ListServiceRolloutsResponse response = serviceManagerClient.listServiceRolloutsCallable().call(request); for (Rollout element : response.getRolloutsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getServiceRollout
public final Rollout getServiceRollout(String serviceName, String rolloutId)
Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; String rolloutId = "rolloutId551248556"; Rollout response = serviceManagerClient.getServiceRollout(serviceName, rolloutId); }
- Parameters:
serviceName
- Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`.rolloutId
- Required. The id of the rollout resource.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getServiceRollout
public final Rollout getServiceRollout(GetServiceRolloutRequest request)
Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GetServiceRolloutRequest request = GetServiceRolloutRequest.newBuilder() .setServiceName("serviceName-1928572192") .setRolloutId("rolloutId551248556") .build(); Rollout response = serviceManagerClient.getServiceRollout(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getServiceRolloutCallable
public final com.google.api.gax.rpc.UnaryCallable<GetServiceRolloutRequest,Rollout> getServiceRolloutCallable()
Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GetServiceRolloutRequest request = GetServiceRolloutRequest.newBuilder() .setServiceName("serviceName-1928572192") .setRolloutId("rolloutId551248556") .build(); ApiFuture<Rollout> future = serviceManagerClient.getServiceRolloutCallable().futureCall(request); // Do something. Rollout response = future.get(); }
-
createServiceRolloutAsync
public final com.google.api.gax.longrunning.OperationFuture<Rollout,OperationMetadata> createServiceRolloutAsync(String serviceName, Rollout rollout)
Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.
Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.
Operation<response: Rollout>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { String serviceName = "serviceName-1928572192"; Rollout rollout = Rollout.newBuilder().build(); Rollout response = serviceManagerClient.createServiceRolloutAsync(serviceName, rollout).get(); }
- Parameters:
serviceName
- Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`.rollout
- Required. The rollout resource. The `service_name` field is output only.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createServiceRolloutAsync
public final com.google.api.gax.longrunning.OperationFuture<Rollout,OperationMetadata> createServiceRolloutAsync(CreateServiceRolloutRequest request)
Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.
Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.
Operation<response: Rollout>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { CreateServiceRolloutRequest request = CreateServiceRolloutRequest.newBuilder() .setServiceName("serviceName-1928572192") .setRollout(Rollout.newBuilder().build()) .build(); Rollout response = serviceManagerClient.createServiceRolloutAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createServiceRolloutOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CreateServiceRolloutRequest,Rollout,OperationMetadata> createServiceRolloutOperationCallable()
Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.
Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.
Operation<response: Rollout>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { CreateServiceRolloutRequest request = CreateServiceRolloutRequest.newBuilder() .setServiceName("serviceName-1928572192") .setRollout(Rollout.newBuilder().build()) .build(); OperationFuture<Rollout, OperationMetadata> future = serviceManagerClient.createServiceRolloutOperationCallable().futureCall(request); // Do something. Rollout response = future.get(); }
-
createServiceRolloutCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateServiceRolloutRequest,com.google.longrunning.Operation> createServiceRolloutCallable()
Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the logging configuration will be pushed to Google Cloud Logging.Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so that the latest Rollout will not be blocked by previous Rollouts.
Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most recent) rollouts are kept for each service. The rest will be deleted eventually.
Operation<response: Rollout>
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { CreateServiceRolloutRequest request = CreateServiceRolloutRequest.newBuilder() .setServiceName("serviceName-1928572192") .setRollout(Rollout.newBuilder().build()) .build(); ApiFuture<Operation> future = serviceManagerClient.createServiceRolloutCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
generateConfigReport
public final GenerateConfigReportResponse generateConfigReport(com.google.protobuf.Any newConfig, com.google.protobuf.Any oldConfig)
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_valueIf GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { Any newConfig = Any.newBuilder().build(); Any oldConfig = Any.newBuilder().build(); GenerateConfigReportResponse response = serviceManagerClient.generateConfigReport(newConfig, oldConfig); }
- Parameters:
newConfig
- Required. Service configuration for which we want to generate the report. For this version of API, the supported types are [google.api.servicemanagement.v1.ConfigRef][google.api.servicemanagement.v1.ConfigRef], [google.api.servicemanagement.v1.ConfigSource][google.api.servicemanagement.v1.ConfigSource], and [google.api.Service][google.api.Service]oldConfig
- Optional. Service configuration against which the comparison will be done. For this version of API, the supported types are [google.api.servicemanagement.v1.ConfigRef][google.api.servicemanagement.v1.ConfigRef], [google.api.servicemanagement.v1.ConfigSource][google.api.servicemanagement.v1.ConfigSource], and [google.api.Service][google.api.Service]- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
generateConfigReport
public final GenerateConfigReportResponse generateConfigReport(GenerateConfigReportRequest request)
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_valueIf GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GenerateConfigReportRequest request = GenerateConfigReportRequest.newBuilder() .setNewConfig(Any.newBuilder().build()) .setOldConfig(Any.newBuilder().build()) .build(); GenerateConfigReportResponse response = serviceManagerClient.generateConfigReport(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
generateConfigReportCallable
public final com.google.api.gax.rpc.UnaryCallable<GenerateConfigReportRequest,GenerateConfigReportResponse> generateConfigReportCallable()
Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_valueIf GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare GenerateConfigReportRequest.new_value with the last pushed service configuration.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GenerateConfigReportRequest request = GenerateConfigReportRequest.newBuilder() .setNewConfig(Any.newBuilder().build()) .setOldConfig(Any.newBuilder().build()) .build(); ApiFuture<GenerateConfigReportResponse> future = serviceManagerClient.generateConfigReportCallable().futureCall(request); // Do something. GenerateConfigReportResponse response = future.get(); }
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource("SetIamPolicyRequest1223629066".toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Policy response = serviceManagerClient.setIamPolicy(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { SetIamPolicyRequest request = SetIamPolicyRequest.newBuilder() .setResource("SetIamPolicyRequest1223629066".toString()) .setPolicy(Policy.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Policy> future = serviceManagerClient.setIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource("GetIamPolicyRequest-1527610370".toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); Policy response = serviceManagerClient.getIamPolicy(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicyCallable()
Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { GetIamPolicyRequest request = GetIamPolicyRequest.newBuilder() .setResource("GetIamPolicyRequest-1527610370".toString()) .setOptions(GetPolicyOptions.newBuilder().build()) .build(); ApiFuture<Policy> future = serviceManagerClient.getIamPolicyCallable().futureCall(request); // Do something. Policy response = future.get(); }
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource("TestIamPermissionsRequest942398222".toString()) .addAllPermissions(new ArrayList<String>()) .build(); TestIamPermissionsResponse response = serviceManagerClient.testIamPermissions(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a `NOT_FOUND` error.Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.
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 (ServiceManagerClient serviceManagerClient = ServiceManagerClient.create()) { TestIamPermissionsRequest request = TestIamPermissionsRequest.newBuilder() .setResource("TestIamPermissionsRequest942398222".toString()) .addAllPermissions(new ArrayList<String>()) .build(); ApiFuture<TestIamPermissionsResponse> future = serviceManagerClient.testIamPermissionsCallable().futureCall(request); // Do something. TestIamPermissionsResponse response = future.get(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-