Class ServiceManagerGrpc.ServiceManagerBlockingStub (3.17.0)

public static final class ServiceManagerGrpc.ServiceManagerBlockingStub extends AbstractBlockingStub<ServiceManagerGrpc.ServiceManagerBlockingStub>

A stub to allow clients to do synchronous rpc calls to service ServiceManager.

Google Service Management API

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > ServiceManagerGrpc.ServiceManagerBlockingStub

Methods

build(Channel channel, CallOptions callOptions)

protected ServiceManagerGrpc.ServiceManagerBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
ServiceManagerGrpc.ServiceManagerBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createService(CreateServiceRequest request)

public Operation createService(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>

Parameter
NameDescription
requestCreateServiceRequest
Returns
TypeDescription
Operation

createServiceConfig(CreateServiceConfigRequest request)

public 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. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted eventually.

Parameter
NameDescription
requestCreateServiceConfigRequest
Returns
TypeDescription
com.google.api.Service

createServiceRollout(CreateServiceRolloutRequest request)

public Operation createServiceRollout(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>

Parameter
NameDescription
requestCreateServiceRolloutRequest
Returns
TypeDescription
Operation

deleteService(DeleteServiceRequest request)

public Operation deleteService(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 to restore the service. After 30 days, the service will be permanently deleted. Operation<response: google.protobuf.Empty>

Parameter
NameDescription
requestDeleteServiceRequest
Returns
TypeDescription
Operation

generateConfigReport(GenerateConfigReportRequest request)

public GenerateConfigReportResponse generateConfigReport(GenerateConfigReportRequest request)

Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If 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.

Parameter
NameDescription
requestGenerateConfigReportRequest
Returns
TypeDescription
GenerateConfigReportResponse

getService(GetServiceRequest request)

public ManagedService getService(GetServiceRequest request)

Gets a managed service. Authentication is required unless the service is public.

Parameter
NameDescription
requestGetServiceRequest
Returns
TypeDescription
ManagedService

getServiceConfig(GetServiceConfigRequest request)

public Service getServiceConfig(GetServiceConfigRequest request)

Gets a service configuration (version) for a managed service.

Parameter
NameDescription
requestGetServiceConfigRequest
Returns
TypeDescription
com.google.api.Service

getServiceRollout(GetServiceRolloutRequest request)

public Rollout getServiceRollout(GetServiceRolloutRequest request)

Gets a service configuration rollout.

Parameter
NameDescription
requestGetServiceRolloutRequest
Returns
TypeDescription
Rollout

listServiceConfigs(ListServiceConfigsRequest request)

public ListServiceConfigsResponse listServiceConfigs(ListServiceConfigsRequest request)

Lists the history of the service configuration for a managed service, from the newest to the oldest.

Parameter
NameDescription
requestListServiceConfigsRequest
Returns
TypeDescription
ListServiceConfigsResponse

listServiceRollouts(ListServiceRolloutsRequest request)

public ListServiceRolloutsResponse listServiceRollouts(ListServiceRolloutsRequest request)

Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.

Parameter
NameDescription
requestListServiceRolloutsRequest
Returns
TypeDescription
ListServiceRolloutsResponse

listServices(ListServicesRequest request)

public ListServicesResponse 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.

Parameter
NameDescription
requestListServicesRequest
Returns
TypeDescription
ListServicesResponse

submitConfigSource(SubmitConfigSourceRequest request)

public Operation submitConfigSource(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. 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>

Parameter
NameDescription
requestSubmitConfigSourceRequest
Returns
TypeDescription
Operation

undeleteService(UndeleteServiceRequest request)

public Operation undeleteService(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>

Parameter
NameDescription
requestUndeleteServiceRequest
Returns
TypeDescription
Operation