com.google.api.services.servicemanagement

Class ServiceManagement.Services

java.lang.Object

com.google.api.services.servicemanagement.ServiceManagement.Services

Enclosing class:

ServiceManagement

public class ServiceManagement.Services
extends Object

The "services" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ServiceManagement.Services.Configs The "configs" collection of methods.
class	ServiceManagement.Services.Consumers The "consumers" collection of methods.
class	ServiceManagement.Services.Create
class	ServiceManagement.Services.Delete
class	ServiceManagement.Services.Disable
class	ServiceManagement.Services.Enable
class	ServiceManagement.Services.GenerateConfigReport
class	ServiceManagement.Services.Get
class	ServiceManagement.Services.GetConfig
class	ServiceManagement.Services.GetIamPolicy
class	ServiceManagement.Services.List
class	ServiceManagement.Services.Rollouts The "rollouts" collection of methods.
class	ServiceManagement.Services.SetIamPolicy
class	ServiceManagement.Services.TestIamPermissions
class	ServiceManagement.Services.Undelete

Constructor Summary

Constructors

Constructor and Description
Services()

Method Summary

Modifier and Type	Method and Description
ServiceManagement.Services.Configs	configs() An accessor for creating requests from the Configs collection.
ServiceManagement.Services.Consumers	consumers() An accessor for creating requests from the Consumers collection.
ServiceManagement.Services.Create	create(ManagedService content) Creates a new managed service.
ServiceManagement.Services.Delete	delete(String serviceName) Deletes a managed service.
ServiceManagement.Services.Disable	disable(String serviceName, DisableServiceRequest content) Disables a service for a project, so it can no longer be be used for the project.
ServiceManagement.Services.Enable	enable(String serviceName, EnableServiceRequest content) Enables a service for a project, so it can be used for the project.
ServiceManagement.Services.GenerateConfigReport	generateConfigReport(GenerateConfigReportRequest content) 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.
ServiceManagement.Services.Get	get(String serviceName) Gets a managed service.
ServiceManagement.Services.GetConfig	getConfig(String serviceName) Gets a service configuration (version) for a managed service.
ServiceManagement.Services.GetIamPolicy	getIamPolicy(String resource, GetIamPolicyRequest content) Gets the access control policy for a resource.
ServiceManagement.Services.List	list() Lists managed services.
ServiceManagement.Services.Rollouts	rollouts() An accessor for creating requests from the Rollouts collection.
ServiceManagement.Services.SetIamPolicy	setIamPolicy(String resource, SetIamPolicyRequest content) Sets the access control policy on the specified resource.
ServiceManagement.Services.TestIamPermissions	testIamPermissions(String resource, TestIamPermissionsRequest content) Returns permissions that a caller has on the specified resource.
ServiceManagement.Services.Undelete	undelete(String serviceName) Revives a previously deleted managed service.

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 ServiceManagement.Services.Create create(ManagedService content)
                                         throws IOException

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 Create a request for the method "services.create". This request holds the parameters needed by the servicemanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the ManagedService

Returns:

the request

Throws:

IOException

delete

public ServiceManagement.Services.Delete delete(String serviceName)
                                         throws IOException

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 to restore the service. After 30 days, the service will be permanently deleted. Operation Create a request for the method "services.delete". This request holds the parameters needed by the servicemanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

serviceName - Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.

Returns:

the request

Throws:

IOException

disable

public ServiceManagement.Services.Disable disable(String serviceName,
                                                  DisableServiceRequest content)
                                           throws IOException

Disables a service for a project, so it can no longer be be used for the project. It prevents accidental usage that may cause unexpected billing charges or security leaks. Operation Create a request for the method "services.disable". This request holds the parameters needed by the servicemanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the DisableServiceRequest

Returns:

the request

Throws:

IOException

enable

public ServiceManagement.Services.Enable enable(String serviceName,
                                                EnableServiceRequest content)
                                         throws IOException

Enables a service for a project, so it can be used for the project. See [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for more information. Operation Create a request for the method "services.enable". This request holds the parameters needed by the servicemanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the EnableServiceRequest

Returns:

the request

Throws:

IOException

generateConfigReport

public ServiceManagement.Services.GenerateConfigReport generateConfigReport(GenerateConfigReportRequest content)
                                                                     throws IOException

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. Create a request for the method "services.generateConfigReport". This request holds the parameters needed by the servicemanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the GenerateConfigReportRequest

Returns:

the request

Throws:

IOException

get

public ServiceManagement.Services.Get get(String serviceName)
                                   throws IOException

Gets a managed service. Authentication is required unless the service is public. Create a request for the method "services.get". This request holds the parameters needed by the servicemanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

Returns:

the request

Throws:

IOException

getConfig

public ServiceManagement.Services.GetConfig getConfig(String serviceName)
                                               throws IOException

Gets a service configuration (version) for a managed service. Create a request for the method "services.getConfig". This request holds the parameters needed by the servicemanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

serviceName - Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.

Returns:

the request

Throws:

IOException

getIamPolicy

public ServiceManagement.Services.GetIamPolicy getIamPolicy(String resource,
                                                            GetIamPolicyRequest content)
                                                     throws IOException

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. Create a request for the method "services.getIamPolicy". This request holds the parameters needed by the servicemanagement 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 the operation documentation for the appropriate value for this field.

content - the GetIamPolicyRequest

Returns:

the request

Throws:

IOException

list

public ServiceManagement.Services.List list()
                                     throws IOException

Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for. **BETA:** If the caller specifies the `consumer_id`, it returns only the services enabled on the consumer. The `consumer_id` must have the format of "project:{PROJECT-ID}". Create a request for the method "services.list". This request holds the parameters needed by the servicemanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

setIamPolicy

public ServiceManagement.Services.SetIamPolicy setIamPolicy(String resource,
                                                            SetIamPolicyRequest content)
                                                     throws IOException

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. Create a request for the method "services.setIamPolicy". This request holds the parameters needed by the servicemanagement 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 the operation documentation for the appropriate value for this field.

content - the SetIamPolicyRequest

Returns:

the request

Throws:

IOException

testIamPermissions

public ServiceManagement.Services.TestIamPermissions testIamPermissions(String resource,
                                                                        TestIamPermissionsRequest content)
                                                                 throws IOException

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. Create a request for the method "services.testIamPermissions". This request holds the parameters needed by the servicemanagement 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 the operation documentation for the appropriate value for this field.

content - the TestIamPermissionsRequest

Returns:

the request

Throws:

IOException

undelete

public ServiceManagement.Services.Undelete undelete(String serviceName)
                                             throws IOException

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 Create a request for the method "services.undelete". This request holds the parameters needed by the servicemanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

serviceName - Required. The name of the service. See the [overview](/service-management/overview) for naming requirements. For example: `example.googleapis.com`.

Returns:

the request

Throws:

IOException

configs

public ServiceManagement.Services.Configs configs()

An accessor for creating requests from the Configs collection.

The typical use is:

    ServiceManagement servicemanagement = new ServiceManagement(...);
    ServiceManagement.Configs.List request = servicemanagement.configs().list(parameters ...)
 

Returns:

the resource collection

consumers

public ServiceManagement.Services.Consumers consumers()

An accessor for creating requests from the Consumers collection.

The typical use is:

    ServiceManagement servicemanagement = new ServiceManagement(...);
    ServiceManagement.Consumers.List request = servicemanagement.consumers().list(parameters ...)
 

Returns:

the resource collection

rollouts

public ServiceManagement.Services.Rollouts rollouts()

An accessor for creating requests from the Rollouts collection.

The typical use is:

    ServiceManagement servicemanagement = new ServiceManagement(...);
    ServiceManagement.Rollouts.List request = servicemanagement.rollouts().list(parameters ...)
 

Returns:

the resource collection