target.apidocs.com.google.api.services.run.v1.CloudRun.Projects.Locations.Services.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-run Show documentation

There is a newer version: v2-rev20241213-2.0.0

Show newest version







CloudRun.Projects.Locations.Services (Cloud Run Admin API v1-rev20240731-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.run.v1
Class CloudRun.Projects.Locations.Services



java.lang.Object


com.google.api.services.run.v1.CloudRun.Projects.Locations.Services







Enclosing class:
CloudRun.Projects.Locations




public class CloudRun.Projects.Locations.Services
extends Object
The "services" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
CloudRun.Projects.Locations.Services.Create 


class 
CloudRun.Projects.Locations.Services.Delete 


class 
CloudRun.Projects.Locations.Services.Get 


class 
CloudRun.Projects.Locations.Services.GetIamPolicy 


class 
CloudRun.Projects.Locations.Services.List 


class 
CloudRun.Projects.Locations.Services.ReplaceService 


class 
CloudRun.Projects.Locations.Services.SetIamPolicy 


class 
CloudRun.Projects.Locations.Services.TestIamPermissions 









Constructor Summary

Constructors 

Constructor and Description


Services() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CloudRun.Projects.Locations.Services.Create
create(String parent,
      Service content)
Creates a new Service.



CloudRun.Projects.Locations.Services.Delete
delete(String name)
Deletes the provided service.



CloudRun.Projects.Locations.Services.Get
get(String name)
Gets information about a service.



CloudRun.Projects.Locations.Services.GetIamPolicy
getIamPolicy(String resource)
Gets the IAM Access Control policy currently in effect for the given Cloud Run service.



CloudRun.Projects.Locations.Services.List
list(String parent)
Lists services for the given project and region.



CloudRun.Projects.Locations.Services.ReplaceService
replaceService(String name,
              Service content)
Replaces a service.



CloudRun.Projects.Locations.Services.SetIamPolicy
setIamPolicy(String resource,
            SetIamPolicyRequest content)
Sets the IAM Access control policy for the specified Service.



CloudRun.Projects.Locations.Services.TestIamPermissions
testIamPermissions(String resource,
                  TestIamPermissionsRequest content)
Returns permissions that a caller has on the specified Project.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Services
public Services()









Method Detail





create
public CloudRun.Projects.Locations.Services.Create create(String parent,
                                                          Service content)
                                                   throws IOException
Creates a new Service. Service creation will trigger a new deployment. Use GetService, and check
 service.status to determine if the Service is ready.

 Create a request for the method "services.create".

 This request holds the parameters needed by the run server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The resource's parent. In Cloud Run, it may be one of the following: *
        `{project_id_or_number}` * `namespaces/{project_id_or_number}` *
        `namespaces/{project_id_or_number}/services` *
        `projects/{project_id_or_number}/locations/{region}` *
        `projects/{project_id_or_number}/regions/{region}`
content - the Service
Returns:
the request
Throws:
IOException








delete
public CloudRun.Projects.Locations.Services.Delete delete(String name)
                                                   throws IOException
Deletes the provided service. This will cause the Service to stop serving traffic and will delete
 all associated Revisions.

 Create a request for the method "services.delete".

 This request holds the parameters needed by the run server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The fully qualified name of the service to delete. It can be any of the following forms: *
        `namespaces/{project_id_or_number}/services/{service_name}` (only when the `endpoint` is
        regional) * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` *
        `projects/{project_id_or_number}/regions/{region}/services/{service_name}`
Returns:
the request
Throws:
IOException








get
public CloudRun.Projects.Locations.Services.Get get(String name)
                                             throws IOException
Gets information about a service.

 Create a request for the method "services.get".

 This request holds the parameters needed by the run server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The fully qualified name of the service to retrieve. It can be any of the following forms:
        * `namespaces/{project_id_or_number}/services/{service_name}` (only when the `endpoint` is
        regional) * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` *
        `projects/{project_id_or_number}/regions/{region}/services/{service_name}`
Returns:
the request
Throws:
IOException








getIamPolicy
public CloudRun.Projects.Locations.Services.GetIamPolicy getIamPolicy(String resource)
                                                               throws IOException
Gets the IAM Access Control policy currently in effect for the given Cloud Run service. This
 result does not include any inherited policies.

 Create a request for the method "services.getIamPolicy".

 This request holds the parameters needed by the run server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
Returns:
the request
Throws:
IOException








list
public CloudRun.Projects.Locations.Services.List list(String parent)
                                               throws IOException
Lists services for the given project and region. Results are sorted by creation time, descending.

 Create a request for the method "services.list".

 This request holds the parameters needed by the run server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
parent - Required. The parent from where the resources should be listed. In Cloud Run, it may be one of the
        following: * `{project_id_or_number}` * `namespaces/{project_id_or_number}` *
        `namespaces/{project_id_or_number}/services` *
        `projects/{project_id_or_number}/locations/{region}` *
        `projects/{project_id_or_number}/regions/{region}`
Returns:
the request
Throws:
IOException








replaceService
public CloudRun.Projects.Locations.Services.ReplaceService replaceService(String name,
                                                                          Service content)
                                                                   throws IOException
Replaces a service. Only the spec and metadata labels and annotations are modifiable. After the
 Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide
 metadata.resourceVersion to enforce update from last read for optimistic concurrency control.

 Create a request for the method "services.replaceService".

 This request holds the parameters needed by the run server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The fully qualified name of the service to replace. It can be any of the following forms:
        * `namespaces/{project_id_or_number}/services/{service_name}` (only when the `endpoint` is
        regional) * `projects/{project_id_or_number}/locations/{region}/services/{service_name}` *
        `projects/{project_id_or_number}/regions/{region}/services/{service_name}`
content - the Service
Returns:
the request
Throws:
IOException








setIamPolicy
public CloudRun.Projects.Locations.Services.SetIamPolicy setIamPolicy(String resource,
                                                                      SetIamPolicyRequest content)
                                                               throws IOException
Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.

 Create a request for the method "services.setIamPolicy".

 This request holds the parameters needed by the run server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy is being specified. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the SetIamPolicyRequest
Returns:
the request
Throws:
IOException








testIamPermissions
public CloudRun.Projects.Locations.Services.TestIamPermissions testIamPermissions(String resource,
                                                                                  TestIamPermissionsRequest content)
                                                                           throws IOException
Returns permissions that a caller has on the specified Project. There are no permissions required
 for making this API call.

 Create a request for the method "services.testIamPermissions".

 This request holds the parameters needed by the run server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
resource - REQUIRED: The resource for which the policy detail is being requested. See [Resource
        names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
        this field.
content - the TestIamPermissionsRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`CloudRun.Projects.Locations.Services.Create`
`class`	`CloudRun.Projects.Locations.Services.Delete`
`class`	`CloudRun.Projects.Locations.Services.Get`
`class`	`CloudRun.Projects.Locations.Services.GetIamPolicy`
`class`	`CloudRun.Projects.Locations.Services.List`
`class`	`CloudRun.Projects.Locations.Services.ReplaceService`
`class`	`CloudRun.Projects.Locations.Services.SetIamPolicy`
`class`	`CloudRun.Projects.Locations.Services.TestIamPermissions`

Modifier and Type	Method and Description
`CloudRun.Projects.Locations.Services.Create`	`create(String parent, Service content)` Creates a new Service.
`CloudRun.Projects.Locations.Services.Delete`	`delete(String name)` Deletes the provided service.
`CloudRun.Projects.Locations.Services.Get`	`get(String name)` Gets information about a service.
`CloudRun.Projects.Locations.Services.GetIamPolicy`	`getIamPolicy(String resource)` Gets the IAM Access Control policy currently in effect for the given Cloud Run service.
`CloudRun.Projects.Locations.Services.List`	`list(String parent)` Lists services for the given project and region.
`CloudRun.Projects.Locations.Services.ReplaceService`	`replaceService(String name, Service content)` Replaces a service.
`CloudRun.Projects.Locations.Services.SetIamPolicy`	`setIamPolicy(String resource, SetIamPolicyRequest content)` Sets the IAM Access control policy for the specified Service.
`CloudRun.Projects.Locations.Services.TestIamPermissions`	`testIamPermissions(String resource, TestIamPermissionsRequest content)` Returns permissions that a caller has on the specified Project.