Class AppHubClient (0.1.0)

The App Hub API allows you to manage App Hub resources.

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the app hub client.

Releases underlying transport's resources.

Returns a fully-qualified application string.

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates an Application in a host 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 apphub_v1

def sample_create_application():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    application = apphub_v1.Application()
    application.scope.type_ = "REGIONAL"

    request = apphub_v1.CreateApplicationRequest(
        parent="parent_value",
        application_id="application_id_value",
        application=application,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Creates a Service in an Application.

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

def sample_create_service():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    service = apphub_v1.Service()
    service.discovered_service = "discovered_service_value"

    request = apphub_v1.CreateServiceRequest(
        parent="parent_value",
        service_id="service_id_value",
        service=service,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Attaches a service project to the host project.

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

def sample_create_service_project_attachment():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    service_project_attachment = apphub_v1.ServiceProjectAttachment()
    service_project_attachment.service_project = "service_project_value"

    request = apphub_v1.CreateServiceProjectAttachmentRequest(
        parent="parent_value",
        service_project_attachment_id="service_project_attachment_id_value",
        service_project_attachment=service_project_attachment,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Creates a Workload in an Application.

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

def sample_create_workload():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    workload = apphub_v1.Workload()
    workload.discovered_workload = "discovered_workload_value"

    request = apphub_v1.CreateWorkloadRequest(
        parent="parent_value",
        workload_id="workload_id_value",
        workload=workload,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Deletes an Application in a host 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 apphub_v1

def sample_delete_application():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.DeleteApplicationRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

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.

Deletes a Service from an Application.

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

def sample_delete_service():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.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)

Deletes a service project attachment.

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

def sample_delete_service_project_attachment():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.DeleteServiceProjectAttachmentRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Deletes a Workload from an Application.

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

def sample_delete_workload():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.DeleteWorkloadRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Detaches a service project from a host project. You can call this API from any service project without needing access to the host project that it is attached to.

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

def sample_detach_service_project_attachment():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.DetachServiceProjectAttachmentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Returns a fully-qualified discovered_service string.

Returns a fully-qualified discovered_workload string.

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

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

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

Gets an Application in a host 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 apphub_v1

def sample_get_application():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.GetApplicationRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Gets a Discovered Service in a host 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 apphub_v1

def sample_get_discovered_service():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.GetDiscoveredServiceRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Gets a Discovered Workload in a host 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 apphub_v1

def sample_get_discovered_workload():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.GetDiscoveredWorkloadRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Gets information about a location.

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

Gets the latest state of a long-running operation.

Gets a Service in an Application.

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

def sample_get_service():
    # Create a client
    client = apphub_v1.AppHubClient()

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

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

    # Handle the response
    print(response)

Gets a service project attachment.

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

def sample_get_service_project_attachment():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.GetServiceProjectAttachmentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Gets a Workload in an Application.

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

def sample_get_workload():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.GetWorkloadRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Lists Applications in a host 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 apphub_v1

def sample_list_applications():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.ListApplicationsRequest(
        parent="parent_value",
    )

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

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

Lists Discovered Services that can be added to an Application in a host 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 apphub_v1

def sample_list_discovered_services():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.ListDiscoveredServicesRequest(
        parent="parent_value",
    )

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

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

Lists Discovered Workloads that can be added to an Application in a host 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 apphub_v1

def sample_list_discovered_workloads():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.ListDiscoveredWorkloadsRequest(
        parent="parent_value",
    )

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

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

Lists information about the supported locations for this service.

Lists operations that match the specified filter in the request.

Lists service projects attached to the host project.

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

def sample_list_service_project_attachments():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.ListServiceProjectAttachmentsRequest(
        parent="parent_value",
    )

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

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

Lists Services in an Application.

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

def sample_list_services():
    # Create a client
    client = apphub_v1.AppHubClient()

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

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

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

Lists Workloads in an Application.

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

def sample_list_workloads():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.ListWorkloadsRequest(
        parent="parent_value",
    )

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

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

Lists a Discovered Service in a host project and location, with a given resource URI.

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

def sample_lookup_discovered_service():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.LookupDiscoveredServiceRequest(
        parent="parent_value",
        uri="uri_value",
    )

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

    # Handle the response
    print(response)

Lists a Discovered Workload in a host project and location, with a given resource URI.

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

def sample_lookup_discovered_workload():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.LookupDiscoveredWorkloadRequest(
        parent="parent_value",
        uri="uri_value",
    )

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

    # Handle the response
    print(response)

Lists a service project attachment for a given service project. You can call this API from any project to find if it is attached to a host project.

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

def sample_lookup_service_project_attachment():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    request = apphub_v1.LookupServiceProjectAttachmentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parses a application path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a discovered_service path into its component segments.

Parses a discovered_workload path into its component segments.

Parses a service path into its component segments.

Parses a service_project_attachment path into its component segments.

Parses a workload path into its component segments.

Returns a fully-qualified service string.

Returns a fully-qualified service_project_attachment string.

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Updates an Application in a host 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 apphub_v1

def sample_update_application():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    application = apphub_v1.Application()
    application.scope.type_ = "REGIONAL"

    request = apphub_v1.UpdateApplicationRequest(
        application=application,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Updates a Service in an Application.

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

def sample_update_service():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    service = apphub_v1.Service()
    service.discovered_service = "discovered_service_value"

    request = apphub_v1.UpdateServiceRequest(
        service=service,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Updates a Workload in an Application.

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

def sample_update_workload():
    # Create a client
    client = apphub_v1.AppHubClient()

    # Initialize request argument(s)
    workload = apphub_v1.Workload()
    workload.discovered_workload = "discovered_workload_value"

    request = apphub_v1.UpdateWorkloadRequest(
        workload=workload,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Returns a fully-qualified workload string.