package google.api.servicemanagement.v1
Get desktop application:
View/edit binary Protocol Buffers messages
[Google Service Management API](/service-management/overview)
rpc ListServices (, )
servicemanager.proto:47Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for. **BETA:** If the caller specifies the `consumer_id`, it returns only the services enabled on the consumer. The `consumer_id` must have the format of "project:{PROJECT-ID}".
message
servicemanager.proto:243Request message for `ListServices` method.
string producer_project_id = 1
Include services produced by the specified project.
int32 page_size = 5
Requested size of the next page of data.
string page_token = 6
Token identifying which result to start with; returned by a previous list call.
string consumer_id = 7
Include services consumed by the specified consumer. The Google Service Management implementation accepts the following forms: - project:<project_id>
message
servicemanager.proto:263Response message for `ListServices` method.
repeated services = 1
The returned services will only have the name field set.
string next_page_token = 2
Token that can be passed to `ListServices` to resume a paginated query.
rpc GetService (, )
servicemanager.proto:55Gets a managed service. Authentication is required unless the service is public.
message
servicemanager.proto:272Request message for `GetService` method.
string service_name = 1
The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`.
rpc CreateService (, )
servicemanager.proto:65Creates a new managed service. Please note one producer project can own no more than 20 services. Operation<response: ManagedService>
message
servicemanager.proto:279Request message for CreateService method.
optional service = 1
Initial values for the service resource.
rpc DeleteService (, )
servicemanager.proto:81Deletes 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>
message
servicemanager.proto:285Request message for DeleteService method.
string service_name = 1
The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.
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>
message
servicemanager.proto:292Request message for UndeleteService method.
string service_name = 1
The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.
Lists the history of the service configuration for a managed service, from the newest to the oldest.
message
servicemanager.proto:330Request message for ListServiceConfigs method.
string service_name = 1
The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.
string page_token = 2
The token of the page to retrieve.
int32 page_size = 3
The max number of items to include in the response list.
message
servicemanager.proto:343Response message for ListServiceConfigs method.
repeated service_configs = 1
The list of service configuration resources.
string next_page_token = 2
The token of the next page of results.
Gets a service configuration (version) for a managed service.
message
servicemanager.proto:305Request message for GetServiceConfig method.
string service_name = 1
The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.
string config_id = 2
The id of the service configuration resource.
GetServiceConfigRequest.ConfigView view = 3
Specifies which parts of the Service Config should be returned in the response.
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.
message
servicemanager.proto:352Request message for CreateServiceConfig method.
string service_name = 1
The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.
optional service_config = 2
The service configuration resource.
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>
message
servicemanager.proto:362Request message for SubmitConfigSource method.
string service_name = 1
The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.
optional config_source = 2
The source configuration for the service.
bool validate_only = 3
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.
Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest.
message
servicemanager.proto:393Request message for 'ListServiceRollouts'
string service_name = 1
The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.
string page_token = 2
The token of the page to retrieve.
int32 page_size = 3
The max number of items to include in the response list.
string filter = 4
Use `filter` to return subset of rollouts. The following filters are supported: -- To limit the results to only those in [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS', use filter='status=SUCCESS' -- To limit the results to those in [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED' or 'FAILED', use filter='status=CANCELLED OR status=FAILED'
message
servicemanager.proto:416Response message for ListServiceRollouts method.
repeated rollouts = 1
The list of rollout resources.
string next_page_token = 2
The token of the next page of results.
Gets a service configuration [rollout][google.api.servicemanagement.v1.Rollout].
message
servicemanager.proto:425Request message for GetServiceRollout method.
string service_name = 1
The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.
string rollout_id = 2
The id of the rollout resource.
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>
message
servicemanager.proto:383Request message for 'CreateServiceRollout'
string service_name = 1
The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.
optional rollout = 2
The rollout resource. The `service_name` field is output only.
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.
message
servicemanager.proto:471Request message for GenerateConfigReport method.
optional new_config = 1
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]
optional old_config = 2
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]
message
servicemanager.proto:488Response message for GenerateConfigReport method.
string service_name = 1
Name of the service this report belongs to.
string id = 2
ID of the service configuration this report belongs to.
repeated change_reports = 3
list of ChangeReport, each corresponding to comparison between two service configurations.
repeated diagnostics = 4
Errors / Linter warnings associated with the service definition this report belongs to.
Enables a [service][google.api.servicemanagement.v1.ManagedService] for a project, so it can be used for the project. See [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for more information. Operation<response: EnableServiceResponse>
message
servicemanager.proto:435Request message for EnableService method.
string service_name = 1
Name of the service to enable. Specifying an unknown service name will cause the request to fail.
string consumer_id = 2
The identity of consumer resource which service enablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id.
Disables a [service][google.api.servicemanagement.v1.ManagedService] for a project, so it can no longer be be used for the project. It prevents accidental usage that may cause unexpected billing charges or security leaks. Operation<response: DisableServiceResponse>
message
servicemanager.proto:453Request message for DisableService method.
string service_name = 1
Name of the service to disable. Specifying an unknown service name will cause the request to fail.
string consumer_id = 2
The identity of consumer resource which service disablement will be applied to. The Google Service Management implementation accepts the following forms: - "project:<project_id>" Note: this is made compatible with google.api.servicecontrol.v1.Operation.consumer_id.
message
resources.proto:183Change report associated with a particular service configuration. It contains a list of ConfigChanges based on the comparison between two service configurations.
Used in:
repeated config_changes = 1
List of changes between two service configurations. The changes will be alphabetically sorted based on the identifier of each change. A ConfigChange identifier is a dot separated path to the configuration. Example: visibility.rules[selector='LibraryService.CreateBook'].restriction
message
resources.proto:131Generic specification of a source configuration file
Used in:
string file_path = 1
The file name of the configuration file (full or relative path).
bytes file_contents = 3
The bytes that constitute the file.
ConfigFile.FileType file_type = 4
The type of configuration file this represents.
Used in:
FILE_TYPE_UNSPECIFIED = 0
Unknown file type.
SERVICE_CONFIG_YAML = 1
YAML-specification of service.
OPEN_API_JSON = 2
OpenAPI specification, serialized in JSON.
OPEN_API_YAML = 3
OpenAPI specification, serialized in YAML.
FILE_DESCRIPTOR_SET_PROTO = 4
FileDescriptorSet, generated by protoc. To generate, use protoc with imports and source info included. For an example test.proto file, the following command would put the value in a new file named out.pb. $protoc --include_imports --include_source_info test.proto -o out.pb
PROTO_FILE = 6
Uncompiled Proto file. Used for storage and display purposes only, currently server-side compilation is not supported. Should match the inputs to 'protoc' command used to generated FILE_DESCRIPTOR_SET_PROTO. A file of this type can only be included if at least one file of type FILE_DESCRIPTOR_SET_PROTO is included.
message
resources.proto:173Represents a service configuration with its name and id.
string name = 1
Resource name of a service config. It must have the following format: "services/{service name}/configs/{config id}".
message
resources.proto:119Represents a source file which is used to generate the service configuration defined by `google.api.Service`.
Used in:
string id = 5
A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead.
repeated files = 2
Set of source configuration files that are used to generate a service configuration (`google.api.Service`).
message
resources.proto:97Represents a diagnostic message (error or warning)
Used in:
string location = 1
File name and line number of the error or warning.
Diagnostic.Kind kind = 2
The kind of diagnostic information provided.
string message = 3
Message describing the error or warning.
The kind of diagnostic information possible.
Used in:
WARNING = 0
Warnings and errors
ERROR = 1
Only errors
Used in:
BASIC = 0
Server response includes all fields except SourceInfo.
FULL = 1
Server response includes all fields including SourceInfo. SourceFiles are of type 'google.api.servicemanagement.v1.ConfigFile' and are only available for configs created using the SubmitConfigSource method.
message
resources.proto:40The full representation of a Service that is managed by Google Service Management.
Used as response type in: ServiceManager.GetService
Used as field type in: , ,
string service_name = 2
The name of the service. See the [overview](/service-management/overview) for naming requirements.
string producer_project_id = 3
ID of the project that produces and owns this service.
message
resources.proto:50The metadata associated with a long running operation resource.
repeated string resource_names = 1
The full name of the resources that this operation is directly associated with.
repeated steps = 2
Detailed status information for each step. The order is undetermined.
int32 progress_percentage = 3
Percentage of completion of this operation, ranging from 0 to 100.
optional start_time = 4
The start time of the operation.
Code describes the status of the operation (or one of its steps).
Used in:
STATUS_UNSPECIFIED = 0
Unspecifed code.
DONE = 1
The operation or step has completed without errors.
NOT_STARTED = 2
The operation or step has not started yet.
IN_PROGRESS = 3
The operation or step is in progress.
FAILED = 4
The operation or step has completed with errors. If the operation is rollbackable, the rollback completed with errors too.
CANCELLED = 5
The operation or step has completed with cancellation.
message
resources.proto:52Represents the status of one operation step.
Used in:
string description = 2
The short description of the step.
Status status = 4
The status code.
message
resources.proto:195A rollout resource that defines how service configuration versions are pushed to control plane systems. Typically, you create a new version of the service config, and then create a Rollout to push the service config.
Used as response type in: ServiceManager.GetServiceRollout
Used as field type in: ,
string rollout_id = 1
Optional unique identifier of this Rollout. Only lower case letters, digits and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of <date><revision number>, where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'
optional create_time = 2
Creation time of the rollout. Readonly.
string created_by = 3
The user who created the Rollout. Readonly.
Rollout.RolloutStatus status = 4
The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly.
oneof strategy
Strategy that defines which versions of service configurations should be pushed and how they should be used at runtime.
traffic_percent_strategy = 5
Google Service Control selects service configurations based on traffic percentage.
delete_service_strategy = 200
The strategy associated with a rollout to delete a `ManagedService`. Readonly.
string service_name = 8
The name of the service associated with this Rollout.
message
resources.proto:235Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service.
Used in:
(message has no fields)
Status of a Rollout.
Used in:
ROLLOUT_STATUS_UNSPECIFIED = 0
No status specified.
IN_PROGRESS = 1
The Rollout is in progress.
SUCCESS = 2
The Rollout has completed successfully.
CANCELLED = 3
The Rollout has been cancelled. This can happen if you have overlapping Rollout pushes, and the previous ones will be cancelled.
FAILED = 4
The Rollout has failed and the rollback attempt has failed too.
PENDING = 5
The Rollout has not started yet and is pending for execution.
FAILED_ROLLED_BACK = 6
The Rollout has failed and rolled back to the previous successful Rollout.
message
resources.proto:226Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured precentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } }
Used in:
map<string, double> percentages = 1
Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the sum must equal to 100.0.
message
servicemanager.proto:377Response message for SubmitConfigSource method.
optional service_config = 1
The generated service configuration.
message
servicemanager.proto:299Response message for UndeleteService method.
optional service = 1
Revived service resource.