Package types (1.0.4)

API documentation for servicemanagement_v1.types package.

Classes

ChangeReport

Change report associated with a particular service configuration. It contains a list of ConfigChanges based on the comparison between two service configurations.

ConfigFile

Generic specification of a source configuration file .. attribute:: file_path

The file name of the configuration file (full or relative path).

:type: str

ConfigRef

Represents a service configuration with its name and id. .. attribute:: name

Resource name of a service config. It must have the following format: "services/{service name}/configs/{config id}".

:type: str

ConfigSource

Represents a source file which is used to generate the service configuration defined by google.api.Service.

CreateServiceConfigRequest

Request message for CreateServiceConfig method. .. attribute:: service_name

Required. The name of the service. See the overview <https://cloud.google.com/service-management/overview>__ for naming requirements. For example: example.googleapis.com.

:type: str

CreateServiceRequest

Request message for CreateService method. .. attribute:: service

Required. Initial values for the service resource.

:type: google.cloud.servicemanagement_v1.types.ManagedService

CreateServiceRolloutRequest

Request message for 'CreateServiceRollout' .. attribute:: service_name

Required. The name of the service. See the overview <https://cloud.google.com/service-management/overview>__ for naming requirements. For example: example.googleapis.com.

:type: str

DeleteServiceRequest

Request message for DeleteService method. .. attribute:: service_name

Required. The name of the service. See the overview <https://cloud.google.com/service-management/overview>__ for naming requirements. For example: example.googleapis.com.

:type: str

Diagnostic

Represents a diagnostic message (error or warning) .. attribute:: location

File name and line number of the error or warning.

:type: str

DisableServiceRequest

Request message for DisableService method. .. attribute:: service_name

Required. Name of the service to disable. Specifying an unknown service name will cause the request to fail.

:type: str

DisableServiceResponse

Operation payload for DisableService method.

EnableServiceRequest

Request message for EnableService method. .. attribute:: service_name

Required. Name of the service to enable. Specifying an unknown service name will cause the request to fail.

:type: str

EnableServiceResponse

Operation payload for EnableService method.

GenerateConfigReportRequest

Request message for GenerateConfigReport method. .. attribute:: new_config

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]

:type: google.protobuf.any_pb2.Any

GenerateConfigReportResponse

Response message for GenerateConfigReport method. .. attribute:: service_name

Name of the service this report belongs to.

:type: str

GetServiceConfigRequest

Request message for GetServiceConfig method. .. attribute:: service_name

Required. The name of the service. See the overview <https://cloud.google.com/service-management/overview>__ for naming requirements. For example: example.googleapis.com.

:type: str

GetServiceRequest

Request message for GetService method. .. attribute:: service_name

Required. The name of the service. See the ServiceManager overview for naming requirements. For example: example.googleapis.com.

:type: str

GetServiceRolloutRequest

Request message for GetServiceRollout method. .. attribute:: service_name

Required. The name of the service. See the overview <https://cloud.google.com/service-management/overview>__ for naming requirements. For example: example.googleapis.com.

:type: str

ListServiceConfigsRequest

Request message for ListServiceConfigs method. .. attribute:: service_name

Required. The name of the service. See the overview <https://cloud.google.com/service-management/overview>__ for naming requirements. For example: example.googleapis.com.

:type: str

ListServiceConfigsResponse

Response message for ListServiceConfigs method. .. attribute:: service_configs

The list of service configuration resources.

:type: Sequence[google.api.service_pb2.Service]

ListServiceRolloutsRequest

Request message for 'ListServiceRollouts' .. attribute:: service_name

Required. The name of the service. See the overview <https://cloud.google.com/service-management/overview>__ for naming requirements. For example: example.googleapis.com.

:type: str

ListServiceRolloutsResponse

Response message for ListServiceRollouts method. .. attribute:: rollouts

The list of rollout resources.

:type: Sequence[google.cloud.servicemanagement_v1.types.Rollout]

ListServicesRequest

Request message for ListServices method. .. attribute:: producer_project_id

Include services produced by the specified project.

:type: str

ListServicesResponse

Response message for ListServices method. .. attribute:: services

The returned services will only have the name field set.

:type: Sequence[google.cloud.servicemanagement_v1.types.ManagedService]

ManagedService

The full representation of a Service that is managed by Google Service Management.

OperationMetadata

The metadata associated with a long running operation resource.

Rollout

A 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.

SubmitConfigSourceRequest

Request message for SubmitConfigSource method. .. attribute:: service_name

Required. The name of the service. See the overview <https://cloud.google.com/service-management/overview>__ for naming requirements. For example: example.googleapis.com.

:type: str

SubmitConfigSourceResponse

Response message for SubmitConfigSource method. .. attribute:: service_config

The generated service configuration.

:type: google.api.service_pb2.Service

UndeleteServiceRequest

Request message for UndeleteService method. .. attribute:: service_name

Required. The name of the service. See the overview <https://cloud.google.com/service-management/overview>__ for naming requirements. For example: example.googleapis.com.

:type: str

UndeleteServiceResponse

Response message for UndeleteService method. .. attribute:: service

Revived service resource.

:type: google.cloud.servicemanagement_v1.types.ManagedService