com.google.api.services.servicecontrol.v2.ServiceControl Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.servicecontrol.v2;
/**
* Service definition for ServiceControl (v2).
*
*
* Provides admission control and telemetry reporting for services integrated with Service Infrastructure.
*
*
*
* For more information about this service, see the
* API Documentation
*
*
*
* This service uses {@link ServiceControlRequestInitializer} to initialize global parameters via its
* {@link Builder}.
*
*
* @since 1.3
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public class ServiceControl extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient {
// Note: Leave this static initializer at the top of the file.
static {
com.google.api.client.util.Preconditions.checkState(
(com.google.api.client.googleapis.GoogleUtils.MAJOR_VERSION == 1 &&
(com.google.api.client.googleapis.GoogleUtils.MINOR_VERSION >= 32 ||
(com.google.api.client.googleapis.GoogleUtils.MINOR_VERSION == 31 &&
com.google.api.client.googleapis.GoogleUtils.BUGFIX_VERSION >= 1))) ||
com.google.api.client.googleapis.GoogleUtils.MAJOR_VERSION >= 2,
"You are currently running with version %s of google-api-client. " +
"You need at least version 1.31.1 of google-api-client to run version " +
"2.0.0 of the Service Control API library.", com.google.api.client.googleapis.GoogleUtils.VERSION);
}
/**
* The default encoded root URL of the service. This is determined when the library is generated
* and normally should not be changed.
*
* @since 1.7
*/
public static final String DEFAULT_ROOT_URL = "https://servicecontrol.googleapis.com/";
/**
* The default encoded mTLS root URL of the service. This is determined when the library is generated
* and normally should not be changed.
*
* @since 1.31
*/
public static final String DEFAULT_MTLS_ROOT_URL = "https://servicecontrol.mtls.googleapis.com/";
/**
* The default encoded service path of the service. This is determined when the library is
* generated and normally should not be changed.
*
* @since 1.7
*/
public static final String DEFAULT_SERVICE_PATH = "";
/**
* The default encoded batch path of the service. This is determined when the library is
* generated and normally should not be changed.
*
* @since 1.23
*/
public static final String DEFAULT_BATCH_PATH = "batch";
/**
* The default encoded base URL of the service. This is determined when the library is generated
* and normally should not be changed.
*/
public static final String DEFAULT_BASE_URL = DEFAULT_ROOT_URL + DEFAULT_SERVICE_PATH;
/**
* Constructor.
*
*
* Use {@link Builder} if you need to specify any of the optional parameters.
*
*
* @param transport HTTP transport, which should normally be:
*
* - Google App Engine:
* {@code com.google.api.client.extensions.appengine.http.UrlFetchTransport}
* - Android: {@code newCompatibleTransport} from
* {@code com.google.api.client.extensions.android.http.AndroidHttp}
* - Java: {@link com.google.api.client.googleapis.javanet.GoogleNetHttpTransport#newTrustedTransport()}
*
*
* @param jsonFactory JSON factory, which may be:
*
* - Jackson: {@code com.google.api.client.json.jackson2.JacksonFactory}
* - Google GSON: {@code com.google.api.client.json.gson.GsonFactory}
* - Android Honeycomb or higher:
* {@code com.google.api.client.extensions.android.json.AndroidJsonFactory}
*
* @param httpRequestInitializer HTTP request initializer or {@code null} for none
* @since 1.7
*/
public ServiceControl(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory,
com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) {
this(new Builder(transport, jsonFactory, httpRequestInitializer));
}
/**
* @param builder builder
*/
ServiceControl(Builder builder) {
super(builder);
}
@Override
protected void initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest httpClientRequest) throws java.io.IOException {
super.initialize(httpClientRequest);
}
/**
* An accessor for creating requests from the Services collection.
*
* The typical use is:
*
* {@code ServiceControl servicecontrol = new ServiceControl(...);}
* {@code ServiceControl.Services.List request = servicecontrol.services().list(parameters ...)}
*
*
* @return the resource collection
*/
public Services services() {
return new Services();
}
/**
* The "services" collection of methods.
*/
public class Services {
/**
* Private Preview. This feature is only available for approved services. This method provides
* admission control for services that are integrated with [Service
* Infrastructure](https://cloud.google.com/service-infrastructure). It checks whether an operation
* should be allowed based on the service configuration and relevant policies. It must be called
* before the operation is executed. For more information, see [Admission
* Control](https://cloud.google.com/service-infrastructure/docs/admission-control). NOTE: The
* admission control has an expected policy propagation delay of 60s. The caller **must** not depend
* on the most recent policy changes. NOTE: The admission control has a hard limit of 1 referenced
* resources per call. If an operation refers to more than 1 resources, the caller must call the
* Check method multiple times. This method requires the `servicemanagement.services.check`
* permission on the specified service. For more information, see [Service Control API Access
* Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
*
* Create a request for the method "services.check".
*
* This request holds the parameters needed by the servicecontrol server. After setting any
* optional parameters, call the {@link Check#execute()} method to invoke the remote operation.
*
* @param serviceName The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`.
* See [google.api.Service](https://cloud.google.com/service-
* management/reference/rpc/google.api#google.api.Service) for the definition of a service
* name.
* @param content the {@link com.google.api.services.servicecontrol.v2.model.CheckRequest}
* @return the request
*/
public Check check(java.lang.String serviceName, com.google.api.services.servicecontrol.v2.model.CheckRequest content) throws java.io.IOException {
Check result = new Check(serviceName, content);
initialize(result);
return result;
}
public class Check extends ServiceControlRequest {
private static final String REST_PATH = "v2/services/{serviceName}:check";
/**
* Private Preview. This feature is only available for approved services. This method provides
* admission control for services that are integrated with [Service
* Infrastructure](https://cloud.google.com/service-infrastructure). It checks whether an
* operation should be allowed based on the service configuration and relevant policies. It must
* be called before the operation is executed. For more information, see [Admission
* Control](https://cloud.google.com/service-infrastructure/docs/admission-control). NOTE: The
* admission control has an expected policy propagation delay of 60s. The caller **must** not
* depend on the most recent policy changes. NOTE: The admission control has a hard limit of 1
* referenced resources per call. If an operation refers to more than 1 resources, the caller must
* call the Check method multiple times. This method requires the
* `servicemanagement.services.check` permission on the specified service. For more information,
* see [Service Control API Access Control](https://cloud.google.com/service-
* infrastructure/docs/service-control/access-control).
*
* Create a request for the method "services.check".
*
* This request holds the parameters needed by the the servicecontrol server. After setting any
* optional parameters, call the {@link Check#execute()} method to invoke the remote operation.
* {@link
* Check#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} must
* be called to initialize this instance immediately after invoking the constructor.
*
* @param serviceName The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`.
* See [google.api.Service](https://cloud.google.com/service-
* management/reference/rpc/google.api#google.api.Service) for the definition of a service
* name.
* @param content the {@link com.google.api.services.servicecontrol.v2.model.CheckRequest}
* @since 1.13
*/
protected Check(java.lang.String serviceName, com.google.api.services.servicecontrol.v2.model.CheckRequest content) {
super(ServiceControl.this, "POST", REST_PATH, content, com.google.api.services.servicecontrol.v2.model.CheckResponse.class);
this.serviceName = com.google.api.client.util.Preconditions.checkNotNull(serviceName, "Required parameter serviceName must be specified.");
}
@Override
public Check set$Xgafv(java.lang.String $Xgafv) {
return (Check) super.set$Xgafv($Xgafv);
}
@Override
public Check setAccessToken(java.lang.String accessToken) {
return (Check) super.setAccessToken(accessToken);
}
@Override
public Check setAlt(java.lang.String alt) {
return (Check) super.setAlt(alt);
}
@Override
public Check setCallback(java.lang.String callback) {
return (Check) super.setCallback(callback);
}
@Override
public Check setFields(java.lang.String fields) {
return (Check) super.setFields(fields);
}
@Override
public Check setKey(java.lang.String key) {
return (Check) super.setKey(key);
}
@Override
public Check setOauthToken(java.lang.String oauthToken) {
return (Check) super.setOauthToken(oauthToken);
}
@Override
public Check setPrettyPrint(java.lang.Boolean prettyPrint) {
return (Check) super.setPrettyPrint(prettyPrint);
}
@Override
public Check setQuotaUser(java.lang.String quotaUser) {
return (Check) super.setQuotaUser(quotaUser);
}
@Override
public Check setUploadType(java.lang.String uploadType) {
return (Check) super.setUploadType(uploadType);
}
@Override
public Check setUploadProtocol(java.lang.String uploadProtocol) {
return (Check) super.setUploadProtocol(uploadProtocol);
}
/**
* The service name as specified in its service configuration. For example,
* `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-
* management/reference/rpc/google.api#google.api.Service) for the definition of a service
* name.
*/
@com.google.api.client.util.Key
private java.lang.String serviceName;
/** The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`.
See [google.api.Service](https://cloud.google.com/service-
management/reference/rpc/google.api#google.api.Service) for the definition of a service name.
*/
public java.lang.String getServiceName() {
return serviceName;
}
/**
* The service name as specified in its service configuration. For example,
* `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-
* management/reference/rpc/google.api#google.api.Service) for the definition of a service
* name.
*/
public Check setServiceName(java.lang.String serviceName) {
this.serviceName = serviceName;
return this;
}
@Override
public Check set(String parameterName, Object value) {
return (Check) super.set(parameterName, value);
}
}
/**
* Private Preview. This feature is only available for approved services. This method provides
* telemetry reporting for services that are integrated with [Service
* Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of operations
* that have occurred on a service. It must be called after the operations have been executed. For
* more information, see [Telemetry Reporting](https://cloud.google.com/service-
* infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of 1000
* operations and 1MB per Report call. It is recommended to have no more than 100 operations per
* call. This method requires the `servicemanagement.services.report` permission on the specified
* service. For more information, see [Service Control API Access
* Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
*
* Create a request for the method "services.report".
*
* This request holds the parameters needed by the servicecontrol server. After setting any
* optional parameters, call the {@link Report#execute()} method to invoke the remote operation.
*
* @param serviceName The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`.
* See [google.api.Service](https://cloud.google.com/service-
* management/reference/rpc/google.api#google.api.Service) for the definition of a service
* name.
* @param content the {@link com.google.api.services.servicecontrol.v2.model.ReportRequest}
* @return the request
*/
public Report report(java.lang.String serviceName, com.google.api.services.servicecontrol.v2.model.ReportRequest content) throws java.io.IOException {
Report result = new Report(serviceName, content);
initialize(result);
return result;
}
public class Report extends ServiceControlRequest {
private static final String REST_PATH = "v2/services/{serviceName}:report";
/**
* Private Preview. This feature is only available for approved services. This method provides
* telemetry reporting for services that are integrated with [Service
* Infrastructure](https://cloud.google.com/service-infrastructure). It reports a list of
* operations that have occurred on a service. It must be called after the operations have been
* executed. For more information, see [Telemetry Reporting](https://cloud.google.com/service-
* infrastructure/docs/telemetry-reporting). NOTE: The telemetry reporting has a hard limit of
* 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations
* per call. This method requires the `servicemanagement.services.report` permission on the
* specified service. For more information, see [Service Control API Access
* Control](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
*
* Create a request for the method "services.report".
*
* This request holds the parameters needed by the the servicecontrol server. After setting any
* optional parameters, call the {@link Report#execute()} method to invoke the remote operation.
* {@link
* Report#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)} must
* be called to initialize this instance immediately after invoking the constructor.
*
* @param serviceName The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`.
* See [google.api.Service](https://cloud.google.com/service-
* management/reference/rpc/google.api#google.api.Service) for the definition of a service
* name.
* @param content the {@link com.google.api.services.servicecontrol.v2.model.ReportRequest}
* @since 1.13
*/
protected Report(java.lang.String serviceName, com.google.api.services.servicecontrol.v2.model.ReportRequest content) {
super(ServiceControl.this, "POST", REST_PATH, content, com.google.api.services.servicecontrol.v2.model.ReportResponse.class);
this.serviceName = com.google.api.client.util.Preconditions.checkNotNull(serviceName, "Required parameter serviceName must be specified.");
}
@Override
public Report set$Xgafv(java.lang.String $Xgafv) {
return (Report) super.set$Xgafv($Xgafv);
}
@Override
public Report setAccessToken(java.lang.String accessToken) {
return (Report) super.setAccessToken(accessToken);
}
@Override
public Report setAlt(java.lang.String alt) {
return (Report) super.setAlt(alt);
}
@Override
public Report setCallback(java.lang.String callback) {
return (Report) super.setCallback(callback);
}
@Override
public Report setFields(java.lang.String fields) {
return (Report) super.setFields(fields);
}
@Override
public Report setKey(java.lang.String key) {
return (Report) super.setKey(key);
}
@Override
public Report setOauthToken(java.lang.String oauthToken) {
return (Report) super.setOauthToken(oauthToken);
}
@Override
public Report setPrettyPrint(java.lang.Boolean prettyPrint) {
return (Report) super.setPrettyPrint(prettyPrint);
}
@Override
public Report setQuotaUser(java.lang.String quotaUser) {
return (Report) super.setQuotaUser(quotaUser);
}
@Override
public Report setUploadType(java.lang.String uploadType) {
return (Report) super.setUploadType(uploadType);
}
@Override
public Report setUploadProtocol(java.lang.String uploadProtocol) {
return (Report) super.setUploadProtocol(uploadProtocol);
}
/**
* The service name as specified in its service configuration. For example,
* `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-
* management/reference/rpc/google.api#google.api.Service) for the definition of a service
* name.
*/
@com.google.api.client.util.Key
private java.lang.String serviceName;
/** The service name as specified in its service configuration. For example, `"pubsub.googleapis.com"`.
See [google.api.Service](https://cloud.google.com/service-
management/reference/rpc/google.api#google.api.Service) for the definition of a service name.
*/
public java.lang.String getServiceName() {
return serviceName;
}
/**
* The service name as specified in its service configuration. For example,
* `"pubsub.googleapis.com"`. See [google.api.Service](https://cloud.google.com/service-
* management/reference/rpc/google.api#google.api.Service) for the definition of a service
* name.
*/
public Report setServiceName(java.lang.String serviceName) {
this.serviceName = serviceName;
return this;
}
@Override
public Report set(String parameterName, Object value) {
return (Report) super.set(parameterName, value);
}
}
}
/**
* Builder for {@link ServiceControl}.
*
*
* Implementation is not thread-safe.
*
*
* @since 1.3.0
*/
public static final class Builder extends com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient.Builder {
private static String chooseEndpoint(com.google.api.client.http.HttpTransport transport) {
// If the GOOGLE_API_USE_MTLS_ENDPOINT environment variable value is "always", use mTLS endpoint.
// If the env variable is "auto", use mTLS endpoint if and only if the transport is mTLS.
// Use the regular endpoint for all other cases.
String useMtlsEndpoint = System.getenv("GOOGLE_API_USE_MTLS_ENDPOINT");
useMtlsEndpoint = useMtlsEndpoint == null ? "auto" : useMtlsEndpoint;
if ("always".equals(useMtlsEndpoint) || ("auto".equals(useMtlsEndpoint) && transport != null && transport.isMtls())) {
return DEFAULT_MTLS_ROOT_URL;
}
return DEFAULT_ROOT_URL;
}
/**
* Returns an instance of a new builder.
*
* @param transport HTTP transport, which should normally be:
*
* - Google App Engine:
* {@code com.google.api.client.extensions.appengine.http.UrlFetchTransport}
* - Android: {@code newCompatibleTransport} from
* {@code com.google.api.client.extensions.android.http.AndroidHttp}
* - Java: {@link com.google.api.client.googleapis.javanet.GoogleNetHttpTransport#newTrustedTransport()}
*
*
* @param jsonFactory JSON factory, which may be:
*
* - Jackson: {@code com.google.api.client.json.jackson2.JacksonFactory}
* - Google GSON: {@code com.google.api.client.json.gson.GsonFactory}
* - Android Honeycomb or higher:
* {@code com.google.api.client.extensions.android.json.AndroidJsonFactory}
*
* @param httpRequestInitializer HTTP request initializer or {@code null} for none
* @since 1.7
*/
public Builder(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory,
com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) {
super(
transport,
jsonFactory,
Builder.chooseEndpoint(transport),
DEFAULT_SERVICE_PATH,
httpRequestInitializer,
false);
setBatchPath(DEFAULT_BATCH_PATH);
}
/** Builds a new instance of {@link ServiceControl}. */
@Override
public ServiceControl build() {
return new ServiceControl(this);
}
@Override
public Builder setRootUrl(String rootUrl) {
return (Builder) super.setRootUrl(rootUrl);
}
@Override
public Builder setServicePath(String servicePath) {
return (Builder) super.setServicePath(servicePath);
}
@Override
public Builder setBatchPath(String batchPath) {
return (Builder) super.setBatchPath(batchPath);
}
@Override
public Builder setHttpRequestInitializer(com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) {
return (Builder) super.setHttpRequestInitializer(httpRequestInitializer);
}
@Override
public Builder setApplicationName(String applicationName) {
return (Builder) super.setApplicationName(applicationName);
}
@Override
public Builder setSuppressPatternChecks(boolean suppressPatternChecks) {
return (Builder) super.setSuppressPatternChecks(suppressPatternChecks);
}
@Override
public Builder setSuppressRequiredParameterChecks(boolean suppressRequiredParameterChecks) {
return (Builder) super.setSuppressRequiredParameterChecks(suppressRequiredParameterChecks);
}
@Override
public Builder setSuppressAllChecks(boolean suppressAllChecks) {
return (Builder) super.setSuppressAllChecks(suppressAllChecks);
}
/**
* Set the {@link ServiceControlRequestInitializer}.
*
* @since 1.12
*/
public Builder setServiceControlRequestInitializer(
ServiceControlRequestInitializer servicecontrolRequestInitializer) {
return (Builder) super.setGoogleClientRequestInitializer(servicecontrolRequestInitializer);
}
@Override
public Builder setGoogleClientRequestInitializer(
com.google.api.client.googleapis.services.GoogleClientRequestInitializer googleClientRequestInitializer) {
return (Builder) super.setGoogleClientRequestInitializer(googleClientRequestInitializer);
}
@Override
public Builder setUniverseDomain(String universeDomain) {
return (Builder) super.setUniverseDomain(universeDomain);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy