Class ServiceManagerClient (1.3.3)

Version 1.3.3

• 1.12.0 (latest)
• 1.11.0
• 1.10.1
• 1.8.5
• 1.7.0
• 1.6.1
• 1.5.1
• 1.4.0
• 1.3.3
• 1.2.3
• 1.1.1
• 1.0.4
• 0.1.0

ServiceManagerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.servicemanagement_v1.services.service_manager.transports.base.ServiceManagerTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Google Service Management API <https://cloud.google.com/service-infrastructure/docs/overview>__

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
ServiceManagerTransport	The transport used by the client instance.

Methods

ServiceManagerClient

ServiceManagerClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.servicemanagement_v1.services.service_manager.transports.base.ServiceManagerTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the service manager client.

Parameters
Name	Description
credentials	Optional[google.auth.credentials.Credentials] The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport	Union[str, ServiceManagerTransport] The transport to use. If set to None, a transport is chosen automatically.
client_options	google.api_core.client_options.ClientOptions Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info	google.api_core.gapic_v1.client_info.ClientInfo The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

Warning: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_service

create_service(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.CreateServiceRequest, dict]] = None, *, service: Optional[google.cloud.servicemanagement_v1.types.resources.ManagedService] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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>

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_create_service():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.CreateServiceRequest(
    )

    # Make the request
    operation = client.create_service(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.CreateServiceRequest, dict] The request object. Request message for CreateService method.
service	google.cloud.servicemanagement_v1.types.ManagedService Required. Initial values for the service resource. This corresponds to the service field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be ManagedService The full representation of a Service that is managed by Google Service Management.

create_service_config

create_service_config(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.CreateServiceConfigRequest, dict]] = None, *, service_name: Optional[str] = None, service_config: Optional[google.api.service_pb2.Service] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_create_service_config():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.CreateServiceConfigRequest(
        service_name="service_name_value",
    )

    # Make the request
    response = client.create_service_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.CreateServiceConfigRequest, dict] The request object. Request message for CreateServiceConfig method.
service_name	str Required. The name of the service. See the overview https://cloud.google.com/service-infrastructure/docs/overview__ for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
service_config	google.api.service_pb2.Service Required. The service configuration resource. This corresponds to the service_config field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api.service_pb2.Service	Service is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth

create_service_rollout

create_service_rollout(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.CreateServiceRolloutRequest, dict]] = None, *, service_name: Optional[str] = None, rollout: Optional[google.cloud.servicemanagement_v1.types.resources.Rollout] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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>

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_create_service_rollout():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.CreateServiceRolloutRequest(
        service_name="service_name_value",
    )

    # Make the request
    operation = client.create_service_rollout(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.CreateServiceRolloutRequest, dict] The request object. Request message for 'CreateServiceRollout'
service_name	str Required. The name of the service. See the overview https://cloud.google.com/service-infrastructure/docs/overview__ for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
rollout	google.cloud.servicemanagement_v1.types.Rollout Required. The rollout resource. The service_name field is output only. This corresponds to the rollout field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be 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.

delete_service

delete_service(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.DeleteServiceRequest, dict]] = None, *, service_name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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>

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_delete_service():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.DeleteServiceRequest(
        service_name="service_name_value",
    )

    # Make the request
    operation = client.delete_service(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.DeleteServiceRequest, dict] The request object. Request message for DeleteService method.
service_name	str Required. The name of the service. See the overview https://cloud.google.com/service-infrastructure/docs/overview__ for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
ServiceManagerClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
info	dict The service account private key info.

Returns
Type	Description
ServiceManagerClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
ServiceManagerClient	The constructed client.

generate_config_report

generate_config_report(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.GenerateConfigReportRequest, dict]] = None, *, new_config: Optional[google.protobuf.any_pb2.Any] = None, old_config: Optional[google.protobuf.any_pb2.Any] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_generate_config_report():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.GenerateConfigReportRequest(
    )

    # Make the request
    response = client.generate_config_report(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.GenerateConfigReportRequest, dict] The request object. Request message for GenerateConfigReport method.
new_config	google.protobuf.any_pb2.Any 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] This corresponds to the new_config field on the request instance; if request is provided, this should not be set.
old_config	google.protobuf.any_pb2.Any 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] This corresponds to the old_config field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.servicemanagement_v1.types.GenerateConfigReportResponse	Response message for GenerateConfigReport method.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
client_options	google.api_core.client_options.ClientOptions Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns
Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_service

get_service(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.GetServiceRequest, dict]] = None, *, service_name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_get_service():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.GetServiceRequest(
        service_name="service_name_value",
    )

    # Make the request
    response = client.get_service(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.GetServiceRequest, dict] The request object. Request message for GetService method.
service_name	str Required. The name of the service. See the ServiceManager overview for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.servicemanagement_v1.types.ManagedService	The full representation of a Service that is managed by Google Service Management.

get_service_config

get_service_config(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.GetServiceConfigRequest, dict]] = None, *, service_name: Optional[str] = None, config_id: Optional[str] = None, view: Optional[google.cloud.servicemanagement_v1.types.servicemanager.GetServiceConfigRequest.ConfigView] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_get_service_config():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.GetServiceConfigRequest(
        service_name="service_name_value",
        config_id="config_id_value",
    )

    # Make the request
    response = client.get_service_config(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.GetServiceConfigRequest, dict] The request object. Request message for GetServiceConfig method.
service_name	str Required. The name of the service. See the overview https://cloud.google.com/service-infrastructure/docs/overview__ for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
config_id	str Required. The id of the service configuration resource. This field must be specified for the server to return all fields, including SourceInfo. This corresponds to the config_id field on the request instance; if request is provided, this should not be set.
view	google.cloud.servicemanagement_v1.types.GetServiceConfigRequest.ConfigView Specifies which parts of the Service Config should be returned in the response. This corresponds to the view field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api.service_pb2.Service	Service is the root object of Google service configuration schema. It describes basic information about a service, such as the name and the title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. See each proto message definition for details. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth

get_service_rollout

get_service_rollout(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.GetServiceRolloutRequest, dict]] = None, *, service_name: Optional[str] = None, rollout_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a service configuration rollout][google.api.servicemanagement.v1.Rollout].

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_get_service_rollout():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.GetServiceRolloutRequest(
        service_name="service_name_value",
        rollout_id="rollout_id_value",
    )

    # Make the request
    response = client.get_service_rollout(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.GetServiceRolloutRequest, dict] The request object. Request message for GetServiceRollout method.
service_name	str Required. The name of the service. See the overview https://cloud.google.com/service-infrastructure/docs/overview__ for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
rollout_id	str Required. The id of the rollout resource. This corresponds to the rollout_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.servicemanagement_v1.types.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.

list_service_configs

list_service_configs(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.ListServiceConfigsRequest, dict]] = None, *, service_name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_list_service_configs():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.ListServiceConfigsRequest(
        service_name="service_name_value",
    )

    # Make the request
    page_result = client.list_service_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.ListServiceConfigsRequest, dict] The request object. Request message for ListServiceConfigs method.
service_name	str Required. The name of the service. See the overview https://cloud.google.com/service-infrastructure/docs/overview__ for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.servicemanagement_v1.services.service_manager.pagers.ListServiceConfigsPager	Response message for ListServiceConfigs method. Iterating over this object will yield results and resolve additional pages automatically.

list_service_rollouts

list_service_rollouts(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.ListServiceRolloutsRequest, dict]] = None, *, service_name: Optional[str] = None, filter: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_list_service_rollouts():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.ListServiceRolloutsRequest(
        service_name="service_name_value",
        filter="filter_value",
    )

    # Make the request
    page_result = client.list_service_rollouts(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.ListServiceRolloutsRequest, dict] The request object. Request message for 'ListServiceRollouts'
service_name	str Required. The name of the service. See the overview https://cloud.google.com/service-infrastructure/docs/overview__ for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
filter	str Required. 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' This corresponds to the filter field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.servicemanagement_v1.services.service_manager.pagers.ListServiceRolloutsPager	Response message for ListServiceRollouts method. Iterating over this object will yield results and resolve additional pages automatically.

list_services

list_services(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.ListServicesRequest, dict]] = None, *, producer_project_id: Optional[str] = None, consumer_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_list_services():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.ListServicesRequest(
    )

    # Make the request
    page_result = client.list_services(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.ListServicesRequest, dict] The request object. Request message for ListServices method.
producer_project_id	str Include services produced by the specified project. This corresponds to the producer_project_id field on the request instance; if request is provided, this should not be set.
consumer_id	str Include services consumed by the specified consumer. The Google Service Management implementation accepts the following forms: - project:<project_id> This corresponds to the consumer_id field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.cloud.servicemanagement_v1.services.service_manager.pagers.ListServicesPager	Response message for ListServices method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

submit_config_source

submit_config_source(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.SubmitConfigSourceRequest, dict]] = None, *, service_name: Optional[str] = None, config_source: Optional[google.cloud.servicemanagement_v1.types.resources.ConfigSource] = None, validate_only: Optional[bool] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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>

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_submit_config_source():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.SubmitConfigSourceRequest(
        service_name="service_name_value",
    )

    # Make the request
    operation = client.submit_config_source(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.SubmitConfigSourceRequest, dict] The request object. Request message for SubmitConfigSource method.
service_name	str Required. The name of the service. See the overview https://cloud.google.com/service-infrastructure/docs/overview__ for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
config_source	google.cloud.servicemanagement_v1.types.ConfigSource Required. The source configuration for the service. This corresponds to the config_source field on the request instance; if request is provided, this should not be set.
validate_only	bool 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. This corresponds to the validate_only field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be SubmitConfigSourceResponse Response message for SubmitConfigSource method.

undelete_service

undelete_service(request: Optional[Union[google.cloud.servicemanagement_v1.types.servicemanager.UndeleteServiceRequest, dict]] = None, *, service_name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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>

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicemanagement_v1

def sample_undelete_service():
    # Create a client
    client = servicemanagement_v1.ServiceManagerClient()

    # Initialize request argument(s)
    request = servicemanagement_v1.UndeleteServiceRequest(
        service_name="service_name_value",
    )

    # Make the request
    operation = client.undelete_service(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.servicemanagement_v1.types.UndeleteServiceRequest, dict] The request object. Request message for UndeleteService method.
service_name	str Required. The name of the service. See the overview https://cloud.google.com/service-infrastructure/docs/overview__ for naming requirements. For example: example.googleapis.com. This corresponds to the service_name field on the request instance; if request is provided, this should not be set.
retry	google.api_core.retry.Retry Designation of what errors, if any, should be retried.
timeout	float The timeout for this request.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be UndeleteServiceResponse Response message for UndeleteService method.