All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.api.services.compute.model.UrlMap 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.compute.model;

/**
 * Represents a URL Map resource. Compute Engine has two URL Map resources: *
 * [Global](/compute/docs/reference/rest/beta/urlMaps) *
 * [Regional](/compute/docs/reference/rest/beta/regionUrlMaps) A URL map resource is a component of
 * certain types of cloud load balancers and Traffic Director: * urlMaps are used by external
 * HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load
 * balancers. For a list of supported URL map features by the load balancer type, see the Load
 * balancing features: Routing and traffic management table. For a list of supported URL map
 * features for Traffic Director, see the Traffic Director features: Routing and traffic management
 * table. This resource defines mappings from hostnames and URL paths to either a backend service or
 * a backend bucket. To use the global urlMaps resource, the backend service must have a
 * loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps
 * resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more
 * information, read URL Map Concepts.
 *
 * 

This is the Java data model class that specifies how to parse/serialize into the JSON that is * transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: * https://developers.google.com/api-client-library/java/google-http-java-client/json *

* * @author Google, Inc. */ @SuppressWarnings("javadoc") public final class UrlMap extends com.google.api.client.json.GenericJson { /** * [Output Only] Creation timestamp in RFC3339 text format. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String creationTimestamp; /** * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs * advanced routing actions, such as URL rewrites and header transformations, before forwarding * the request to the selected backend. If defaultRouteAction specifies any * weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, * defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction * or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the * urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map * is bound to a target gRPC proxy that has the validateForProxyless field set to true. * The value may be {@code null}. */ @com.google.api.client.util.Key private HttpRouteAction defaultRouteAction; /** * The full or partial URL of the defaultService resource to which traffic is directed if none of * the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as * URL rewrites, take effect before sending the request to the backend. However, if defaultService * is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if * routeAction specifies any weightedBackendServices, service must not be specified. Only one of * defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. * defaultService has no effect when the URL map is bound to a target gRPC proxy that has the * validateForProxyless field set to true. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String defaultService; /** * When none of the specified hostRules match, the request is redirected to a URL specified by * defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction * must not be set. Not supported when the URL map is bound to a target gRPC proxy. * The value may be {@code null}. */ @com.google.api.client.util.Key private HttpRedirectAction defaultUrlRedirect; /** * An optional description of this resource. Provide this property when you create the resource. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String description; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used * in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint * must be provided in order to update the UrlMap, otherwise the request will fail with error 412 * conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String fingerprint; /** * Specifies changes to request and response headers that need to take effect for the selected * backendService. The headerAction specified here take effect after headerAction specified under * pathMatcher. headerAction is not supported for load balancers that have their * loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC * proxy that has validateForProxyless field set to true. * The value may be {@code null}. */ @com.google.api.client.util.Key private HttpHeaderAction headerAction; /** * The list of host rules to use against the URL. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.util.List hostRules; static { // hack to force ProGuard to consider HostRule used, since otherwise it would be stripped out // see https://github.com/google/google-api-java-client/issues/543 com.google.api.client.util.Data.nullOf(HostRule.class); } /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. * The value may be {@code null}. */ @com.google.api.client.util.Key @com.google.api.client.json.JsonString private java.math.BigInteger id; /** * [Output Only] Type of the resource. Always compute#urlMaps for url maps. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String kind; /** * Name of the resource. Provided by the client when the resource is created. The name must be * 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters * long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first * character must be a lowercase letter, and all following characters must be a dash, lowercase * letter, or digit, except the last character, which cannot be a dash. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String name; /** * The list of named PathMatchers to use against the URL. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.util.List pathMatchers; static { // hack to force ProGuard to consider PathMatcher used, since otherwise it would be stripped out // see https://github.com/google/google-api-java-client/issues/543 com.google.api.client.util.Data.nullOf(PathMatcher.class); } /** * [Output Only] URL of the region where the regional URL map resides. This field is not * applicable to global URL maps. You must specify this field as part of the HTTP request URL. It * is not settable as a field in the request body. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String region; /** * [Output Only] Server-defined URL for the resource. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.lang.String selfLink; /** * The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test * cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map * is bound to a target gRPC proxy that has validateForProxyless field set to true. * The value may be {@code null}. */ @com.google.api.client.util.Key private java.util.List tests; /** * [Output Only] Creation timestamp in RFC3339 text format. * @return value or {@code null} for none */ public java.lang.String getCreationTimestamp() { return creationTimestamp; } /** * [Output Only] Creation timestamp in RFC3339 text format. * @param creationTimestamp creationTimestamp or {@code null} for none */ public UrlMap setCreationTimestamp(java.lang.String creationTimestamp) { this.creationTimestamp = creationTimestamp; return this; } /** * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs * advanced routing actions, such as URL rewrites and header transformations, before forwarding * the request to the selected backend. If defaultRouteAction specifies any * weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, * defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction * or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the * urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map * is bound to a target gRPC proxy that has the validateForProxyless field set to true. * @return value or {@code null} for none */ public HttpRouteAction getDefaultRouteAction() { return defaultRouteAction; } /** * defaultRouteAction takes effect when none of the hostRules match. The load balancer performs * advanced routing actions, such as URL rewrites and header transformations, before forwarding * the request to the selected backend. If defaultRouteAction specifies any * weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, * defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction * or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the * urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map * is bound to a target gRPC proxy that has the validateForProxyless field set to true. * @param defaultRouteAction defaultRouteAction or {@code null} for none */ public UrlMap setDefaultRouteAction(HttpRouteAction defaultRouteAction) { this.defaultRouteAction = defaultRouteAction; return this; } /** * The full or partial URL of the defaultService resource to which traffic is directed if none of * the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as * URL rewrites, take effect before sending the request to the backend. However, if defaultService * is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if * routeAction specifies any weightedBackendServices, service must not be specified. Only one of * defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. * defaultService has no effect when the URL map is bound to a target gRPC proxy that has the * validateForProxyless field set to true. * @return value or {@code null} for none */ public java.lang.String getDefaultService() { return defaultService; } /** * The full or partial URL of the defaultService resource to which traffic is directed if none of * the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as * URL rewrites, take effect before sending the request to the backend. However, if defaultService * is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if * routeAction specifies any weightedBackendServices, service must not be specified. Only one of * defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. * defaultService has no effect when the URL map is bound to a target gRPC proxy that has the * validateForProxyless field set to true. * @param defaultService defaultService or {@code null} for none */ public UrlMap setDefaultService(java.lang.String defaultService) { this.defaultService = defaultService; return this; } /** * When none of the specified hostRules match, the request is redirected to a URL specified by * defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction * must not be set. Not supported when the URL map is bound to a target gRPC proxy. * @return value or {@code null} for none */ public HttpRedirectAction getDefaultUrlRedirect() { return defaultUrlRedirect; } /** * When none of the specified hostRules match, the request is redirected to a URL specified by * defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction * must not be set. Not supported when the URL map is bound to a target gRPC proxy. * @param defaultUrlRedirect defaultUrlRedirect or {@code null} for none */ public UrlMap setDefaultUrlRedirect(HttpRedirectAction defaultUrlRedirect) { this.defaultUrlRedirect = defaultUrlRedirect; return this; } /** * An optional description of this resource. Provide this property when you create the resource. * @return value or {@code null} for none */ public java.lang.String getDescription() { return description; } /** * An optional description of this resource. Provide this property when you create the resource. * @param description description or {@code null} for none */ public UrlMap setDescription(java.lang.String description) { this.description = description; return this; } /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used * in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint * must be provided in order to update the UrlMap, otherwise the request will fail with error 412 * conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. * @see #decodeFingerprint() * @return value or {@code null} for none */ public java.lang.String getFingerprint() { return fingerprint; } /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used * in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint * must be provided in order to update the UrlMap, otherwise the request will fail with error 412 * conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. * @see #getFingerprint() * @return Base64 decoded value or {@code null} for none * * @since 1.14 */ public byte[] decodeFingerprint() { return com.google.api.client.util.Base64.decodeBase64(fingerprint); } /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used * in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint * must be provided in order to update the UrlMap, otherwise the request will fail with error 412 * conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. * @see #encodeFingerprint() * @param fingerprint fingerprint or {@code null} for none */ public UrlMap setFingerprint(java.lang.String fingerprint) { this.fingerprint = fingerprint; return this; } /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used * in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint * must be provided in order to update the UrlMap, otherwise the request will fail with error 412 * conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. * @see #setFingerprint() * *

* The value is encoded Base64 or {@code null} for none. *

* * @since 1.14 */ public UrlMap encodeFingerprint(byte[] fingerprint) { this.fingerprint = com.google.api.client.util.Base64.encodeBase64URLSafeString(fingerprint); return this; } /** * Specifies changes to request and response headers that need to take effect for the selected * backendService. The headerAction specified here take effect after headerAction specified under * pathMatcher. headerAction is not supported for load balancers that have their * loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC * proxy that has validateForProxyless field set to true. * @return value or {@code null} for none */ public HttpHeaderAction getHeaderAction() { return headerAction; } /** * Specifies changes to request and response headers that need to take effect for the selected * backendService. The headerAction specified here take effect after headerAction specified under * pathMatcher. headerAction is not supported for load balancers that have their * loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC * proxy that has validateForProxyless field set to true. * @param headerAction headerAction or {@code null} for none */ public UrlMap setHeaderAction(HttpHeaderAction headerAction) { this.headerAction = headerAction; return this; } /** * The list of host rules to use against the URL. * @return value or {@code null} for none */ public java.util.List getHostRules() { return hostRules; } /** * The list of host rules to use against the URL. * @param hostRules hostRules or {@code null} for none */ public UrlMap setHostRules(java.util.List hostRules) { this.hostRules = hostRules; return this; } /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. * @return value or {@code null} for none */ public java.math.BigInteger getId() { return id; } /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. * @param id id or {@code null} for none */ public UrlMap setId(java.math.BigInteger id) { this.id = id; return this; } /** * [Output Only] Type of the resource. Always compute#urlMaps for url maps. * @return value or {@code null} for none */ public java.lang.String getKind() { return kind; } /** * [Output Only] Type of the resource. Always compute#urlMaps for url maps. * @param kind kind or {@code null} for none */ public UrlMap setKind(java.lang.String kind) { this.kind = kind; return this; } /** * Name of the resource. Provided by the client when the resource is created. The name must be * 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters * long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first * character must be a lowercase letter, and all following characters must be a dash, lowercase * letter, or digit, except the last character, which cannot be a dash. * @return value or {@code null} for none */ public java.lang.String getName() { return name; } /** * Name of the resource. Provided by the client when the resource is created. The name must be * 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters * long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first * character must be a lowercase letter, and all following characters must be a dash, lowercase * letter, or digit, except the last character, which cannot be a dash. * @param name name or {@code null} for none */ public UrlMap setName(java.lang.String name) { this.name = name; return this; } /** * The list of named PathMatchers to use against the URL. * @return value or {@code null} for none */ public java.util.List getPathMatchers() { return pathMatchers; } /** * The list of named PathMatchers to use against the URL. * @param pathMatchers pathMatchers or {@code null} for none */ public UrlMap setPathMatchers(java.util.List pathMatchers) { this.pathMatchers = pathMatchers; return this; } /** * [Output Only] URL of the region where the regional URL map resides. This field is not * applicable to global URL maps. You must specify this field as part of the HTTP request URL. It * is not settable as a field in the request body. * @return value or {@code null} for none */ public java.lang.String getRegion() { return region; } /** * [Output Only] URL of the region where the regional URL map resides. This field is not * applicable to global URL maps. You must specify this field as part of the HTTP request URL. It * is not settable as a field in the request body. * @param region region or {@code null} for none */ public UrlMap setRegion(java.lang.String region) { this.region = region; return this; } /** * [Output Only] Server-defined URL for the resource. * @return value or {@code null} for none */ public java.lang.String getSelfLink() { return selfLink; } /** * [Output Only] Server-defined URL for the resource. * @param selfLink selfLink or {@code null} for none */ public UrlMap setSelfLink(java.lang.String selfLink) { this.selfLink = selfLink; return this; } /** * The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test * cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map * is bound to a target gRPC proxy that has validateForProxyless field set to true. * @return value or {@code null} for none */ public java.util.List getTests() { return tests; } /** * The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test * cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map * is bound to a target gRPC proxy that has validateForProxyless field set to true. * @param tests tests or {@code null} for none */ public UrlMap setTests(java.util.List tests) { this.tests = tests; return this; } @Override public UrlMap set(String fieldName, Object value) { return (UrlMap) super.set(fieldName, value); } @Override public UrlMap clone() { return (UrlMap) super.clone(); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy