Class ServicesClient (0.6.0)

  ServicesClient 
 ( 
 * 
 , 
 credentials 
 : 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 Optional 
 [ 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 run_v2 
 . 
 services 
 . 
 services 
 . 
 transports 
 . 
 base 
 . 
 ServicesTransport 
 ]] 
 = 
 None 
 , 
 client_options 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
< google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 object 
> )

Cloud Run Service Control Plane API

Properties

transport

Returns the transport used by the client instance.

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

Methods

ServicesClient

  ServicesClient 
 ( 
 * 
 , 
 credentials 
 : 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 Optional 
 [ 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 run_v2 
 . 
 services 
 . 
 services 
 . 
 transports 
 . 
 base 
 . 
 ServicesTransport 
 ]] 
 = 
 None 
 , 
 client_options 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
< google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 object 
> )

Instantiates the services 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, ServicesTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options
Optional[Union[google.api_core.client_options.ClientOptions, dict]]

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.

  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.

connector_path

  connector_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 connector 
 : 
 str 
 )

Returns a fully-qualified connector string.

create_service

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

Creates a new Service in a given project and location.

 # 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 run_v2

def sample_create_service():
    # Create a client
    client = run_v2.ServicesClient()

    # Initialize request argument(s)
    request = run_v2.CreateServiceRequest(
        parent="parent_value",
        service_id="service_id_value",
    )

    # 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.run_v2.types.CreateServiceRequest , dict]

The request object. Request message for creating a Service.

parent
str

Required. The location and project in which this service should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

service
google.cloud.run_v2.types.Service

Required. The Service instance to create. This corresponds to the service field on the request instance; if request is provided, this should not be set.

service_id
str

Required. The unique identifier for the Service. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the service becomes {parent}/services/{service_id}. This corresponds to the service_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.api_core.operation.Operation
An object representing a long-running operation. The result type for the operation will be Service Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.

crypto_key_path

  crypto_key_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 key_ring 
 : 
 str 
 , 
 crypto_key 
 : 
 str 
 )

Returns a fully-qualified crypto_key string.

delete_operation

  delete_operation 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 DeleteOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED .

Parameters
Name
Description
request
.operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.

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.

delete_service

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

Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.

 # 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 run_v2

def sample_delete_service():
    # Create a client
    client = run_v2.ServicesClient()

    # Initialize request argument(s)
    request = run_v2.DeleteServiceRequest(
        name="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.run_v2.types.DeleteServiceRequest , dict]

The request object. Request message to delete a Service by its full name.

name
str

Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number. This corresponds to the 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 Service Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.
  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
ServicesClient
The constructed client.
  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
ServicesClient
The constructed client.
  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
ServicesClient
The constructed client.

get_iam_policy

  get_iam_policy 
 ( 
 request 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 GetIamPolicyRequest 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.

 # 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 run_v2
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_get_iam_policy():
    # Create a client
    client = run_v2.ServicesClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name
Description
request
Union[ google.iam.v1.iam_policy_pb2.GetIamPolicyRequest , dict]

The request object. Request message for GetIamPolicy method.

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.iam.v1.policy_pb2.Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="" }="" **yaml="" example:**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:" 3="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" documentation](\="">

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 variable 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_operation

  get_operation 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Gets the latest state of a long-running operation.

Parameters
Name
Description
request
.operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.

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
.operations_pb2.Operation
An Operation object.

get_service

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

Gets information about a 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 run_v2

def sample_get_service():
    # Create a client
    client = run_v2.ServicesClient()

    # Initialize request argument(s)
    request = run_v2.GetServiceRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name
Description
request
Union[ google.cloud.run_v2.types.GetServiceRequest , dict]

The request object. Request message for obtaining a Service by its full name.

name
str

Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number. This corresponds to the 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.run_v2.types.Service
Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.

list_operations

  list_operations 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Lists operations that match the specified filter in the request.

Parameters
Name
Description
request
.operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.

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
.operations_pb2.ListOperationsResponse
Response message for ListOperations method.

list_services

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

Lists Services.

 # 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 run_v2

def sample_list_services():
    # Create a client
    client = run_v2.ServicesClient()

    # Initialize request argument(s)
    request = run_v2.ListServicesRequest(
        parent="parent_value",
    )

    # 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.run_v2.types.ListServicesRequest , dict]

The request object. Request message for retrieving a list of Services.

parent
str

Required. The location and project to list resources on. Location must be a valid GCP region, and cannot be the "-" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number. This corresponds to the parent 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.run_v2.services.services.pagers.ListServicesPager
Response message containing a list of Services. Iterating over this object will yield results and resolve additional pages automatically.
  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.

parse_connector_path

  parse_connector_path 
 ( 
 path 
 : 
 str 
 )

Parses a connector path into its component segments.

parse_crypto_key_path

  parse_crypto_key_path 
 ( 
 path 
 : 
 str 
 )

Parses a crypto_key path into its component segments.

parse_revision_path

  parse_revision_path 
 ( 
 path 
 : 
 str 
 )

Parses a revision path into its component segments.

parse_secret_path

  parse_secret_path 
 ( 
 path 
 : 
 str 
 )

Parses a secret path into its component segments.

parse_secret_version_path

  parse_secret_version_path 
 ( 
 path 
 : 
 str 
 )

Parses a secret_version path into its component segments.

parse_service_path

  parse_service_path 
 ( 
 path 
 : 
 str 
 )

Parses a service path into its component segments.

revision_path

  revision_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 service 
 : 
 str 
 , 
 revision 
 : 
 str 
 )

Returns a fully-qualified revision string.

secret_path

  secret_path 
 ( 
 project 
 : 
 str 
 , 
 secret 
 : 
 str 
 )

Returns a fully-qualified secret string.

secret_version_path

  secret_version_path 
 ( 
 project 
 : 
 str 
 , 
 secret 
 : 
 str 
 , 
 version 
 : 
 str 
 )

Returns a fully-qualified secret_version string.

service_path

  service_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 service 
 : 
 str 
 )

Returns a fully-qualified service string.

set_iam_policy

  set_iam_policy 
 ( 
 request 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 SetIamPolicyRequest 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.

 # 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 run_v2
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_set_iam_policy():
    # Create a client
    client = run_v2.ServicesClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.SetIamPolicyRequest(
        resource="resource_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name
Description
request
Union[ google.iam.v1.iam_policy_pb2.SetIamPolicyRequest , dict]

The request object. Request message for SetIamPolicy method.

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.iam.v1.policy_pb2.Policy
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="" }="" **yaml="" example:**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:" 3="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" documentation](\="">

test_iam_permissions

  test_iam_permissions 
 ( 
 request 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsRequest 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.

 # 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 run_v2
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_test_iam_permissions():
    # Create a client
    client = run_v2.ServicesClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

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

    # Handle the response
    print(response)
Parameters
Name
Description
request
Union[ google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest , dict]

The request object. Request message for TestIamPermissions method.

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.iam.v1.iam_policy_pb2.TestIamPermissionsResponse
Response message for TestIamPermissions method.

update_service

  update_service 
 ( 
 request 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 run_v2 
 . 
 types 
 . 
 service 
 . 
 UpdateServiceRequest 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 * 
 , 
 service 
 : 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 run_v2 
 . 
 types 
 . 
 service 
 . 
 Service 
 ] 
 = 
 None 
 , 
 retry 
 : 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Updates a 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 run_v2

def sample_update_service():
    # Create a client
    client = run_v2.ServicesClient()

    # Initialize request argument(s)
    request = run_v2.UpdateServiceRequest(
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name
Description
request
Union[ google.cloud.run_v2.types.UpdateServiceRequest , dict]

The request object. Request message for updating a service.

service
google.cloud.run_v2.types.Service

Required. The Service to be updated. 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 Service Service acts as a top-level container that manages a set of configurations and revision templates which implement a network service. Service exists to provide a singular abstraction which can be access controlled, reasoned about, and which encapsulates software lifecycle decisions such as rollout policy and team resource ownership.