target.apidocs.com.google.api.services.servicemanagement.model.Endpoint.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-servicemanagement Show documentation

There is a newer version: v1-rev20241106-2.0.0

Show newest version







Endpoint (Service Management API v1-rev20240823-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.servicemanagement.model
Class Endpoint



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.servicemanagement.model.Endpoint













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class Endpoint
extends com.google.api.client.json.GenericJson
`Endpoint` describes a network address of a service that serves a set of APIs. It is commonly
 known as a service endpoint. A service may expose any number of service endpoints, and all
 service endpoints share the same service definition, such as quota limits and monitoring metrics.
 Example: type: google.api.Service name: library-example.googleapis.com endpoints: # Declares
 network address `https://library-example.googleapis.com` # for service `library-
 example.googleapis.com`. The `https` scheme # is implicit for all service endpoints. Other
 schemes may be # supported in the future. - name: library-example.googleapis.com allow_cors:
 false - name: content-staging-library-example.googleapis.com # Allows HTTP OPTIONS calls to be
 passed to the API frontend, for it # to decide whether the subsequent cross-origin request is
 allowed # to proceed. allow_cors: true

  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 Service Management API. For a detailed explanation
 see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


Endpoint() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Endpoint
clone() 


List<String>
getAliases()
Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and
 will be provisioned in the GCP stack for the Regional Endpoints.



Boolean
getAllowCors()
Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain
 traffic, would allow the backends served from this endpoint to receive and respond to HTTP
 OPTIONS requests.



String
getName()
The canonical name of this endpoint.



String
getTarget()
The specification of an Internet routable address of API frontend that will handle requests to
 this [API Endpoint](https://cloud.google.com/apis/design/glossary).



Endpoint
set(String fieldName,
   Object value) 


Endpoint
setAliases(List<String> aliases)
Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and
 will be provisioned in the GCP stack for the Regional Endpoints.



Endpoint
setAllowCors(Boolean allowCors)
Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain
 traffic, would allow the backends served from this endpoint to receive and respond to HTTP
 OPTIONS requests.



Endpoint
setName(String name)
The canonical name of this endpoint.



Endpoint
setTarget(String target)
The specification of an Internet routable address of API frontend that will handle requests to
 this [API Endpoint](https://cloud.google.com/apis/design/glossary).







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Endpoint
public Endpoint()









Method Detail





getAliases
public List<String> getAliases()
Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and
 will be provisioned in the GCP stack for the Regional Endpoints.

Returns:
value or null for none








setAliases
public Endpoint setAliases(List<String> aliases)
Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and
 will be provisioned in the GCP stack for the Regional Endpoints.

Parameters:
aliases - aliases or null for none








getAllowCors
public Boolean getAllowCors()
Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain
 traffic, would allow the backends served from this endpoint to receive and respond to HTTP
 OPTIONS requests. The response will be used by the browser to determine whether the subsequent
 cross-origin request is allowed to proceed.

Returns:
value or null for none








setAllowCors
public Endpoint setAllowCors(Boolean allowCors)
Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain
 traffic, would allow the backends served from this endpoint to receive and respond to HTTP
 OPTIONS requests. The response will be used by the browser to determine whether the subsequent
 cross-origin request is allowed to proceed.

Parameters:
allowCors - allowCors or null for none








getName
public String getName()
The canonical name of this endpoint.

Returns:
value or null for none








setName
public Endpoint setName(String name)
The canonical name of this endpoint.

Parameters:
name - name or null for none








getTarget
public String getTarget()
The specification of an Internet routable address of API frontend that will handle requests to
 this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid
 IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or
 "myservice.appspot.com".

Returns:
value or null for none








setTarget
public Endpoint setTarget(String target)
The specification of an Internet routable address of API frontend that will handle requests to
 this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be either a valid
 IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or
 "myservice.appspot.com".

Parameters:
target - target or null for none








set
public Endpoint set(String fieldName,
                    Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public Endpoint clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














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	Method and Description
`Endpoint`	`clone()`
`List<String>`	`getAliases()` Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints.
`Boolean`	`getAllowCors()` Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests.
`String`	`getName()` The canonical name of this endpoint.
`String`	`getTarget()` The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).
`Endpoint`	`set(String fieldName, Object value)`
`Endpoint`	`setAliases(List<String> aliases)` Aliases for this endpoint, these will be served by the same UrlMap as the parent endpoint, and will be provisioned in the GCP stack for the Regional Endpoints.
`Endpoint`	`setAllowCors(Boolean allowCors)` Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to HTTP OPTIONS requests.
`Endpoint`	`setName(String name)` The canonical name of this endpoint.
`Endpoint`	`setTarget(String target)` The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).