Interface ServiceManagerGrpc.AsyncService (3.27.0)

public static interface ServiceManagerGrpc.AsyncService

Methods

createService(CreateServiceRequest request, StreamObserver<Operation> responseObserver)

public default void createService(CreateServiceRequest request, StreamObserver<Operation> responseObserver)

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>

Parameters
NameDescription
requestCreateServiceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

createServiceConfig(CreateServiceConfigRequest request, StreamObserver<Service> responseObserver)

public default void createServiceConfig(CreateServiceConfigRequest request, StreamObserver<Service> responseObserver)

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.

Parameters
NameDescription
requestCreateServiceConfigRequest
responseObserverio.grpc.stub.StreamObserver<com.google.api.Service>

createServiceRollout(CreateServiceRolloutRequest request, StreamObserver<Operation> responseObserver)

public default void createServiceRollout(CreateServiceRolloutRequest request, StreamObserver<Operation> responseObserver)

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>

Parameters
NameDescription
requestCreateServiceRolloutRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteService(DeleteServiceRequest request, StreamObserver<Operation> responseObserver)

public default void deleteService(DeleteServiceRequest request, StreamObserver<Operation> responseObserver)

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>

Parameters
NameDescription
requestDeleteServiceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

generateConfigReport(GenerateConfigReportRequest request, StreamObserver<GenerateConfigReportResponse> responseObserver)

public default void generateConfigReport(GenerateConfigReportRequest request, StreamObserver<GenerateConfigReportResponse> responseObserver)

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.

Parameters
NameDescription
requestGenerateConfigReportRequest
responseObserverio.grpc.stub.StreamObserver<GenerateConfigReportResponse>

getService(GetServiceRequest request, StreamObserver<ManagedService> responseObserver)

public default void getService(GetServiceRequest request, StreamObserver<ManagedService> responseObserver)

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

Parameters
NameDescription
requestGetServiceRequest
responseObserverio.grpc.stub.StreamObserver<ManagedService>

getServiceConfig(GetServiceConfigRequest request, StreamObserver<Service> responseObserver)

public default void getServiceConfig(GetServiceConfigRequest request, StreamObserver<Service> responseObserver)

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

Parameters
NameDescription
requestGetServiceConfigRequest
responseObserverio.grpc.stub.StreamObserver<com.google.api.Service>

getServiceRollout(GetServiceRolloutRequest request, StreamObserver<Rollout> responseObserver)

public default void getServiceRollout(GetServiceRolloutRequest request, StreamObserver<Rollout> responseObserver)

Gets a service configuration rollout.

Parameters
NameDescription
requestGetServiceRolloutRequest
responseObserverio.grpc.stub.StreamObserver<Rollout>

listServiceConfigs(ListServiceConfigsRequest request, StreamObserver<ListServiceConfigsResponse> responseObserver)

public default void listServiceConfigs(ListServiceConfigsRequest request, StreamObserver<ListServiceConfigsResponse> responseObserver)

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

Parameters
NameDescription
requestListServiceConfigsRequest
responseObserverio.grpc.stub.StreamObserver<ListServiceConfigsResponse>

listServiceRollouts(ListServiceRolloutsRequest request, StreamObserver<ListServiceRolloutsResponse> responseObserver)

public default void listServiceRollouts(ListServiceRolloutsRequest request, StreamObserver<ListServiceRolloutsResponse> responseObserver)

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

Parameters
NameDescription
requestListServiceRolloutsRequest
responseObserverio.grpc.stub.StreamObserver<ListServiceRolloutsResponse>

listServices(ListServicesRequest request, StreamObserver<ListServicesResponse> responseObserver)

public default void listServices(ListServicesRequest request, StreamObserver<ListServicesResponse> responseObserver)

Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for.

Parameters
NameDescription
requestListServicesRequest
responseObserverio.grpc.stub.StreamObserver<ListServicesResponse>

submitConfigSource(SubmitConfigSourceRequest request, StreamObserver<Operation> responseObserver)

public default void submitConfigSource(SubmitConfigSourceRequest request, StreamObserver<Operation> responseObserver)

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>

Parameters
NameDescription
requestSubmitConfigSourceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

undeleteService(UndeleteServiceRequest request, StreamObserver<Operation> responseObserver)

public default void undeleteService(UndeleteServiceRequest request, StreamObserver<Operation> responseObserver)

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>

Parameters
NameDescription
requestUndeleteServiceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>