target.apidocs.com.google.api.services.serviceusage.v1beta1.ServiceUsage.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-serviceusage Show documentation

There is a newer version: v1-rev20241219-2.0.0

Show newest version







ServiceUsage.Services (Service Usage API v1beta1-rev20230412-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.serviceusage.v1beta1
Class ServiceUsage.Services



java.lang.Object


com.google.api.services.serviceusage.v1beta1.ServiceUsage.Services







Enclosing class:
ServiceUsage




public class ServiceUsage.Services
extends Object
The "services" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
ServiceUsage.Services.BatchEnable 


class 
ServiceUsage.Services.ConsumerQuotaMetrics
The "consumerQuotaMetrics" collection of methods.



class 
ServiceUsage.Services.Disable 


class 
ServiceUsage.Services.Enable 


class 
ServiceUsage.Services.GenerateServiceIdentity 


class 
ServiceUsage.Services.Get 


class 
ServiceUsage.Services.List 









Constructor Summary

Constructors 

Constructor and Description


Services() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


ServiceUsage.Services.BatchEnable
batchEnable(String parent,
           BatchEnableServicesRequest content)
Enables multiple services on a project.



ServiceUsage.Services.ConsumerQuotaMetrics
consumerQuotaMetrics()
An accessor for creating requests from the ConsumerQuotaMetrics collection.



ServiceUsage.Services.Disable
disable(String name,
       DisableServiceRequest content)
Disables a service so that it can no longer be used with a project.



ServiceUsage.Services.Enable
enable(String name,
      EnableServiceRequest content)
Enables a service so that it can be used with a project.



ServiceUsage.Services.GenerateServiceIdentity
generateServiceIdentity(String parent)
Generates service identity for service.



ServiceUsage.Services.Get
get(String name)
Returns the service configuration and enabled state for a given service.



ServiceUsage.Services.List
list(String parent)
Lists all services available to the specified project, and the current state of those services
 with respect to the 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





batchEnable
public ServiceUsage.Services.BatchEnable batchEnable(String parent,
                                                     BatchEnableServicesRequest content)
                                              throws IOException
Enables multiple services on a project. The operation is atomic: if enabling any service fails,
 then the entire batch fails, and no state changes occur. Operation response type:
 `google.protobuf.Empty`

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

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

Parameters:
parent - Parent to enable services on. An example name would be: `projects/123` where `123` is the project
        number (not project ID). The `BatchEnableServices` method currently only supports
        projects.
content - the BatchEnableServicesRequest
Returns:
the request
Throws:
IOException








disable
public ServiceUsage.Services.Disable disable(String name,
                                             DisableServiceRequest content)
                                      throws IOException
Disables a service so that it can no longer be used with a project. This prevents unintended
 usage that may cause unexpected billing charges or security leaks. It is not valid to call the
 disable method on a service that is not currently enabled. Callers will receive a
 `FAILED_PRECONDITION` status if the target service is not currently enabled. Operation response
 type: `google.protobuf.Empty`

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

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

Parameters:
name - Name of the consumer and service to disable the service on. The enable and disable methods currently
        only support projects. An example name would be:
        `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not
        project ID).
content - the DisableServiceRequest
Returns:
the request
Throws:
IOException








enable
public ServiceUsage.Services.Enable enable(String name,
                                           EnableServiceRequest content)
                                    throws IOException
Enables a service so that it can be used with a project. Operation response type:
 `google.protobuf.Empty`

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

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

Parameters:
name - Name of the consumer and service to enable the service on. The `EnableService` and `DisableService`
        methods currently only support projects. Enabling a service requires that the service is
        public or is shared with the user enabling the service. An example name would be:
        `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not
        project ID).
content - the EnableServiceRequest
Returns:
the request
Throws:
IOException








generateServiceIdentity
public ServiceUsage.Services.GenerateServiceIdentity generateServiceIdentity(String parent)
                                                                      throws IOException
Generates service identity for service.

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

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

Parameters:
parent - Name of the consumer and service to generate an identity for. The `GenerateServiceIdentity` methods
        currently only support projects. An example name would be:
        `projects/123/services/example.googleapis.com` where `123` is the project number.
Returns:
the request
Throws:
IOException








get
public ServiceUsage.Services.Get get(String name)
                              throws IOException
Returns the service configuration and enabled state for a given service.

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

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

Parameters:
name - Name of the consumer and service to get the `ConsumerState` for. An example name would be:
        `projects/123/services/serviceusage.googleapis.com` where `123` is the project number (not
        project ID).
Returns:
the request
Throws:
IOException








list
public ServiceUsage.Services.List list(String parent)
                                throws IOException
Lists all services available to the specified project, and the current state of those services
 with respect to the project. The list includes all public services, all services for which the
 calling user has the `servicemanagement.services.bind` permission, and all services that have
 already been enabled on the project. The list can be filtered to only include services in a
 specific state, for example to only include services enabled on the project.

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

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

Parameters:
parent - Parent to search for services on. An example name would be: `projects/123` where `123` is the
        project number (not project ID).
Returns:
the request
Throws:
IOException








consumerQuotaMetrics
public ServiceUsage.Services.ConsumerQuotaMetrics consumerQuotaMetrics()
An accessor for creating requests from the ConsumerQuotaMetrics collection.

 The typical use is:
     ServiceUsage serviceusage = new ServiceUsage(...);
    ServiceUsage.ConsumerQuotaMetrics.List request = serviceusage.consumerQuotaMetrics().list(parameters ...)
 

Returns:
the resource collection














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–2023 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`ServiceUsage.Services.BatchEnable`
`class`	`ServiceUsage.Services.ConsumerQuotaMetrics` The "consumerQuotaMetrics" collection of methods.
`class`	`ServiceUsage.Services.Disable`
`class`	`ServiceUsage.Services.Enable`
`class`	`ServiceUsage.Services.GenerateServiceIdentity`
`class`	`ServiceUsage.Services.Get`
`class`	`ServiceUsage.Services.List`

Modifier and Type	Method and Description
`ServiceUsage.Services.BatchEnable`	`batchEnable(String parent, BatchEnableServicesRequest content)` Enables multiple services on a project.
`ServiceUsage.Services.ConsumerQuotaMetrics`	`consumerQuotaMetrics()` An accessor for creating requests from the ConsumerQuotaMetrics collection.
`ServiceUsage.Services.Disable`	`disable(String name, DisableServiceRequest content)` Disables a service so that it can no longer be used with a project.
`ServiceUsage.Services.Enable`	`enable(String name, EnableServiceRequest content)` Enables a service so that it can be used with a project.
`ServiceUsage.Services.GenerateServiceIdentity`	`generateServiceIdentity(String parent)` Generates service identity for service.
`ServiceUsage.Services.Get`	`get(String name)` Returns the service configuration and enabled state for a given service.
`ServiceUsage.Services.List`	`list(String parent)` Lists all services available to the specified project, and the current state of those services with respect to the project.