Liking cljdoc? Tell your friends :D

happygapi.compute.backendServices

Compute Engine API: backendServices. Creates and runs virtual machines on Google Cloud Platform. See: https://cloud.google.com/compute/api/reference/rest/v1/backendServices

Compute Engine API: backendServices.
Creates and runs virtual machines on Google Cloud Platform. 
See: https://cloud.google.com/compute/api/reference/rest/v1/backendServices
raw docstring

addSignedUrlKey$clj

(addSignedUrlKey$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/addSignedUrlKey

Required parameters: backendService, project

Optional parameters: requestId

Body:

{:keyName string, :keyValue string}

Adds a key for validating requests with signed URLs for this backend service.

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/addSignedUrlKey

Required parameters: backendService, project

Optional parameters: requestId

Body: 

{:keyName string, :keyValue string}

Adds a key for validating requests with signed URLs for this backend service.
sourceraw docstring

aggregatedList$clj

(aggregatedList$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/aggregatedList

Required parameters: project

Optional parameters: filter, pageToken, orderBy, returnPartialSuccess, maxResults, includeAllScopes

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/aggregatedList

Required parameters: project

Optional parameters: filter, pageToken, orderBy, returnPartialSuccess, maxResults, includeAllScopes

Retrieves the list of all BackendService resources, regional and global, available to the specified project.
sourceraw docstring

delete$clj

(delete$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/delete

Required parameters: backendService, project

Optional parameters: requestId

Deletes the specified BackendService resource.

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/delete

Required parameters: backendService, project

Optional parameters: requestId

Deletes the specified BackendService resource.
sourceraw docstring

deleteSignedUrlKey$clj

(deleteSignedUrlKey$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/deleteSignedUrlKey

Required parameters: project, keyName, backendService

Optional parameters: requestId

Deletes a key for validating requests with signed URLs for this backend service.

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/deleteSignedUrlKey

Required parameters: project, keyName, backendService

Optional parameters: requestId

Deletes a key for validating requests with signed URLs for this backend service.
sourceraw docstring

get$clj

(get$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/get

Required parameters: project, backendService

Optional parameters: none

Returns the specified BackendService resource. Gets a list of available backend services.

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/get

Required parameters: project, backendService

Optional parameters: none

Returns the specified BackendService resource. Gets a list of available backend services.
sourceraw docstring

getHealth$clj

(getHealth$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/getHealth

Required parameters: backendService, project

Optional parameters: none

Body:

{:group string}

Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/getHealth

Required parameters: backendService, project

Optional parameters: none

Body: 

{:group string}

Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }
sourceraw docstring

insert$clj

(insert$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/insert

Required parameters: project

Optional parameters: requestId

Body:

{:description string, :securitySettings {:subjectAltNames [string], :clientTlsPolicy string}, :customResponseHeaders [string], :creationTimestamp string, :protocol string, :enableCDN boolean, :connectionDraining {:drainingTimeoutSec integer}, :name string, :maxStreamDuration {:seconds string, :nanos integer}, :portName string, :cdnPolicy {:defaultTtl integer, :serveWhileStale integer, :signedUrlKeyNames [string], :maxTtl integer, :signedUrlCacheMaxAgeSec string, :requestCoalescing boolean, :negativeCaching boolean, :bypassCacheOnRequestHeaders [BackendServiceCdnPolicyBypassCacheOnRequestHeader], :negativeCachingPolicy [BackendServiceCdnPolicyNegativeCachingPolicy], :cacheKeyPolicy CacheKeyPolicy, :clientTtl integer, :cacheMode string}, :outlierDetection {:successRateStdevFactor integer, :successRateMinimumHosts integer, :enforcingSuccessRate integer, :maxEjectionPercent integer, :successRateRequestVolume integer, :interval Duration, :consecutiveGatewayFailure integer, :baseEjectionTime Duration, :enforcingConsecutiveGatewayFailure integer, :consecutiveErrors integer, :enforcingConsecutiveErrors integer}, :selfLink string, :loadBalancingScheme string, :consistentHash {:httpCookie ConsistentHashLoadBalancerSettingsHttpCookie, :httpHeaderName string, :minimumRingSize string}, :port integer, :healthChecks [string], :region string, :circuitBreakers {:maxRetries integer, :maxRequestsPerConnection integer, :maxConnections integer, :maxRequests integer, :maxPendingRequests integer}, :iap {:enabled boolean, :oauth2ClientSecretSha256 string, :oauth2ClientId string, :oauth2ClientSecret string}, :id string, :kind string, :localityLbPolicy string, :failoverPolicy {:failoverRatio number, :dropTrafficIfUnhealthy boolean, :disableConnectionDrainOnFailover boolean}, :sessionAffinity string, :timeoutSec integer, :network string, :backends [{:description string, :failover boolean, :capacityScaler number, :group string, :maxRatePerInstance number, :maxConnectionsPerEndpoint integer, :balancingMode string, :maxConnections integer, :maxRatePerEndpoint number, :maxConnectionsPerInstance integer, :maxUtilization number, :maxRate integer}], :customRequestHeaders [string], :logConfig {:enable boolean, :sampleRate number}, :fingerprint string, :affinityCookieTtlSec integer, :securityPolicy string}

Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/insert

Required parameters: project

Optional parameters: requestId

Body: 

{:description string,
 :securitySettings {:subjectAltNames [string],
                    :clientTlsPolicy string},
 :customResponseHeaders [string],
 :creationTimestamp string,
 :protocol string,
 :enableCDN boolean,
 :connectionDraining {:drainingTimeoutSec integer},
 :name string,
 :maxStreamDuration {:seconds string, :nanos integer},
 :portName string,
 :cdnPolicy {:defaultTtl integer,
             :serveWhileStale integer,
             :signedUrlKeyNames [string],
             :maxTtl integer,
             :signedUrlCacheMaxAgeSec string,
             :requestCoalescing boolean,
             :negativeCaching boolean,
             :bypassCacheOnRequestHeaders [BackendServiceCdnPolicyBypassCacheOnRequestHeader],
             :negativeCachingPolicy [BackendServiceCdnPolicyNegativeCachingPolicy],
             :cacheKeyPolicy CacheKeyPolicy,
             :clientTtl integer,
             :cacheMode string},
 :outlierDetection {:successRateStdevFactor integer,
                    :successRateMinimumHosts integer,
                    :enforcingSuccessRate integer,
                    :maxEjectionPercent integer,
                    :successRateRequestVolume integer,
                    :interval Duration,
                    :consecutiveGatewayFailure integer,
                    :baseEjectionTime Duration,
                    :enforcingConsecutiveGatewayFailure integer,
                    :consecutiveErrors integer,
                    :enforcingConsecutiveErrors integer},
 :selfLink string,
 :loadBalancingScheme string,
 :consistentHash {:httpCookie ConsistentHashLoadBalancerSettingsHttpCookie,
                  :httpHeaderName string,
                  :minimumRingSize string},
 :port integer,
 :healthChecks [string],
 :region string,
 :circuitBreakers {:maxRetries integer,
                   :maxRequestsPerConnection integer,
                   :maxConnections integer,
                   :maxRequests integer,
                   :maxPendingRequests integer},
 :iap {:enabled boolean,
       :oauth2ClientSecretSha256 string,
       :oauth2ClientId string,
       :oauth2ClientSecret string},
 :id string,
 :kind string,
 :localityLbPolicy string,
 :failoverPolicy {:failoverRatio number,
                  :dropTrafficIfUnhealthy boolean,
                  :disableConnectionDrainOnFailover boolean},
 :sessionAffinity string,
 :timeoutSec integer,
 :network string,
 :backends [{:description string,
             :failover boolean,
             :capacityScaler number,
             :group string,
             :maxRatePerInstance number,
             :maxConnectionsPerEndpoint integer,
             :balancingMode string,
             :maxConnections integer,
             :maxRatePerEndpoint number,
             :maxConnectionsPerInstance integer,
             :maxUtilization number,
             :maxRate integer}],
 :customRequestHeaders [string],
 :logConfig {:enable boolean, :sampleRate number},
 :fingerprint string,
 :affinityCookieTtlSec integer,
 :securityPolicy string}

Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview .
sourceraw docstring

list$clj

(list$ auth parameters)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/list

Required parameters: project

Optional parameters: orderBy, returnPartialSuccess, filter, pageToken, maxResults

Retrieves the list of BackendService resources available to the specified project.

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/list

Required parameters: project

Optional parameters: orderBy, returnPartialSuccess, filter, pageToken, maxResults

Retrieves the list of BackendService resources available to the specified project.
sourceraw docstring

patch$clj

(patch$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/patch

Required parameters: backendService, project

Optional parameters: requestId

Body:

{:description string, :securitySettings {:subjectAltNames [string], :clientTlsPolicy string}, :customResponseHeaders [string], :creationTimestamp string, :protocol string, :enableCDN boolean, :connectionDraining {:drainingTimeoutSec integer}, :name string, :maxStreamDuration {:seconds string, :nanos integer}, :portName string, :cdnPolicy {:defaultTtl integer, :serveWhileStale integer, :signedUrlKeyNames [string], :maxTtl integer, :signedUrlCacheMaxAgeSec string, :requestCoalescing boolean, :negativeCaching boolean, :bypassCacheOnRequestHeaders [BackendServiceCdnPolicyBypassCacheOnRequestHeader], :negativeCachingPolicy [BackendServiceCdnPolicyNegativeCachingPolicy], :cacheKeyPolicy CacheKeyPolicy, :clientTtl integer, :cacheMode string}, :outlierDetection {:successRateStdevFactor integer, :successRateMinimumHosts integer, :enforcingSuccessRate integer, :maxEjectionPercent integer, :successRateRequestVolume integer, :interval Duration, :consecutiveGatewayFailure integer, :baseEjectionTime Duration, :enforcingConsecutiveGatewayFailure integer, :consecutiveErrors integer, :enforcingConsecutiveErrors integer}, :selfLink string, :loadBalancingScheme string, :consistentHash {:httpCookie ConsistentHashLoadBalancerSettingsHttpCookie, :httpHeaderName string, :minimumRingSize string}, :port integer, :healthChecks [string], :region string, :circuitBreakers {:maxRetries integer, :maxRequestsPerConnection integer, :maxConnections integer, :maxRequests integer, :maxPendingRequests integer}, :iap {:enabled boolean, :oauth2ClientSecretSha256 string, :oauth2ClientId string, :oauth2ClientSecret string}, :id string, :kind string, :localityLbPolicy string, :failoverPolicy {:failoverRatio number, :dropTrafficIfUnhealthy boolean, :disableConnectionDrainOnFailover boolean}, :sessionAffinity string, :timeoutSec integer, :network string, :backends [{:description string, :failover boolean, :capacityScaler number, :group string, :maxRatePerInstance number, :maxConnectionsPerEndpoint integer, :balancingMode string, :maxConnections integer, :maxRatePerEndpoint number, :maxConnectionsPerInstance integer, :maxUtilization number, :maxRate integer}], :customRequestHeaders [string], :logConfig {:enable boolean, :sampleRate number}, :fingerprint string, :affinityCookieTtlSec integer, :securityPolicy string}

Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/patch

Required parameters: backendService, project

Optional parameters: requestId

Body: 

{:description string,
 :securitySettings {:subjectAltNames [string],
                    :clientTlsPolicy string},
 :customResponseHeaders [string],
 :creationTimestamp string,
 :protocol string,
 :enableCDN boolean,
 :connectionDraining {:drainingTimeoutSec integer},
 :name string,
 :maxStreamDuration {:seconds string, :nanos integer},
 :portName string,
 :cdnPolicy {:defaultTtl integer,
             :serveWhileStale integer,
             :signedUrlKeyNames [string],
             :maxTtl integer,
             :signedUrlCacheMaxAgeSec string,
             :requestCoalescing boolean,
             :negativeCaching boolean,
             :bypassCacheOnRequestHeaders [BackendServiceCdnPolicyBypassCacheOnRequestHeader],
             :negativeCachingPolicy [BackendServiceCdnPolicyNegativeCachingPolicy],
             :cacheKeyPolicy CacheKeyPolicy,
             :clientTtl integer,
             :cacheMode string},
 :outlierDetection {:successRateStdevFactor integer,
                    :successRateMinimumHosts integer,
                    :enforcingSuccessRate integer,
                    :maxEjectionPercent integer,
                    :successRateRequestVolume integer,
                    :interval Duration,
                    :consecutiveGatewayFailure integer,
                    :baseEjectionTime Duration,
                    :enforcingConsecutiveGatewayFailure integer,
                    :consecutiveErrors integer,
                    :enforcingConsecutiveErrors integer},
 :selfLink string,
 :loadBalancingScheme string,
 :consistentHash {:httpCookie ConsistentHashLoadBalancerSettingsHttpCookie,
                  :httpHeaderName string,
                  :minimumRingSize string},
 :port integer,
 :healthChecks [string],
 :region string,
 :circuitBreakers {:maxRetries integer,
                   :maxRequestsPerConnection integer,
                   :maxConnections integer,
                   :maxRequests integer,
                   :maxPendingRequests integer},
 :iap {:enabled boolean,
       :oauth2ClientSecretSha256 string,
       :oauth2ClientId string,
       :oauth2ClientSecret string},
 :id string,
 :kind string,
 :localityLbPolicy string,
 :failoverPolicy {:failoverRatio number,
                  :dropTrafficIfUnhealthy boolean,
                  :disableConnectionDrainOnFailover boolean},
 :sessionAffinity string,
 :timeoutSec integer,
 :network string,
 :backends [{:description string,
             :failover boolean,
             :capacityScaler number,
             :group string,
             :maxRatePerInstance number,
             :maxConnectionsPerEndpoint integer,
             :balancingMode string,
             :maxConnections integer,
             :maxRatePerEndpoint number,
             :maxConnectionsPerInstance integer,
             :maxUtilization number,
             :maxRate integer}],
 :customRequestHeaders [string],
 :logConfig {:enable boolean, :sampleRate number},
 :fingerprint string,
 :affinityCookieTtlSec integer,
 :securityPolicy string}

Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
sourceraw docstring

setSecurityPolicy$clj

(setSecurityPolicy$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/setSecurityPolicy

Required parameters: backendService, project

Optional parameters: requestId

Body:

{:securityPolicy string}

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/setSecurityPolicy

Required parameters: backendService, project

Optional parameters: requestId

Body: 

{:securityPolicy string}

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview
sourceraw docstring

update$clj

(update$ auth parameters body)

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/update

Required parameters: project, backendService

Optional parameters: requestId

Body:

{:description string, :securitySettings {:subjectAltNames [string], :clientTlsPolicy string}, :customResponseHeaders [string], :creationTimestamp string, :protocol string, :enableCDN boolean, :connectionDraining {:drainingTimeoutSec integer}, :name string, :maxStreamDuration {:seconds string, :nanos integer}, :portName string, :cdnPolicy {:defaultTtl integer, :serveWhileStale integer, :signedUrlKeyNames [string], :maxTtl integer, :signedUrlCacheMaxAgeSec string, :requestCoalescing boolean, :negativeCaching boolean, :bypassCacheOnRequestHeaders [BackendServiceCdnPolicyBypassCacheOnRequestHeader], :negativeCachingPolicy [BackendServiceCdnPolicyNegativeCachingPolicy], :cacheKeyPolicy CacheKeyPolicy, :clientTtl integer, :cacheMode string}, :outlierDetection {:successRateStdevFactor integer, :successRateMinimumHosts integer, :enforcingSuccessRate integer, :maxEjectionPercent integer, :successRateRequestVolume integer, :interval Duration, :consecutiveGatewayFailure integer, :baseEjectionTime Duration, :enforcingConsecutiveGatewayFailure integer, :consecutiveErrors integer, :enforcingConsecutiveErrors integer}, :selfLink string, :loadBalancingScheme string, :consistentHash {:httpCookie ConsistentHashLoadBalancerSettingsHttpCookie, :httpHeaderName string, :minimumRingSize string}, :port integer, :healthChecks [string], :region string, :circuitBreakers {:maxRetries integer, :maxRequestsPerConnection integer, :maxConnections integer, :maxRequests integer, :maxPendingRequests integer}, :iap {:enabled boolean, :oauth2ClientSecretSha256 string, :oauth2ClientId string, :oauth2ClientSecret string}, :id string, :kind string, :localityLbPolicy string, :failoverPolicy {:failoverRatio number, :dropTrafficIfUnhealthy boolean, :disableConnectionDrainOnFailover boolean}, :sessionAffinity string, :timeoutSec integer, :network string, :backends [{:description string, :failover boolean, :capacityScaler number, :group string, :maxRatePerInstance number, :maxConnectionsPerEndpoint integer, :balancingMode string, :maxConnections integer, :maxRatePerEndpoint number, :maxConnectionsPerInstance integer, :maxUtilization number, :maxRate integer}], :customRequestHeaders [string], :logConfig {:enable boolean, :sampleRate number}, :fingerprint string, :affinityCookieTtlSec integer, :securityPolicy string}

Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.

https://cloud.google.com/compute/api/reference/rest/v1/backendServices/update

Required parameters: project, backendService

Optional parameters: requestId

Body: 

{:description string,
 :securitySettings {:subjectAltNames [string],
                    :clientTlsPolicy string},
 :customResponseHeaders [string],
 :creationTimestamp string,
 :protocol string,
 :enableCDN boolean,
 :connectionDraining {:drainingTimeoutSec integer},
 :name string,
 :maxStreamDuration {:seconds string, :nanos integer},
 :portName string,
 :cdnPolicy {:defaultTtl integer,
             :serveWhileStale integer,
             :signedUrlKeyNames [string],
             :maxTtl integer,
             :signedUrlCacheMaxAgeSec string,
             :requestCoalescing boolean,
             :negativeCaching boolean,
             :bypassCacheOnRequestHeaders [BackendServiceCdnPolicyBypassCacheOnRequestHeader],
             :negativeCachingPolicy [BackendServiceCdnPolicyNegativeCachingPolicy],
             :cacheKeyPolicy CacheKeyPolicy,
             :clientTtl integer,
             :cacheMode string},
 :outlierDetection {:successRateStdevFactor integer,
                    :successRateMinimumHosts integer,
                    :enforcingSuccessRate integer,
                    :maxEjectionPercent integer,
                    :successRateRequestVolume integer,
                    :interval Duration,
                    :consecutiveGatewayFailure integer,
                    :baseEjectionTime Duration,
                    :enforcingConsecutiveGatewayFailure integer,
                    :consecutiveErrors integer,
                    :enforcingConsecutiveErrors integer},
 :selfLink string,
 :loadBalancingScheme string,
 :consistentHash {:httpCookie ConsistentHashLoadBalancerSettingsHttpCookie,
                  :httpHeaderName string,
                  :minimumRingSize string},
 :port integer,
 :healthChecks [string],
 :region string,
 :circuitBreakers {:maxRetries integer,
                   :maxRequestsPerConnection integer,
                   :maxConnections integer,
                   :maxRequests integer,
                   :maxPendingRequests integer},
 :iap {:enabled boolean,
       :oauth2ClientSecretSha256 string,
       :oauth2ClientId string,
       :oauth2ClientSecret string},
 :id string,
 :kind string,
 :localityLbPolicy string,
 :failoverPolicy {:failoverRatio number,
                  :dropTrafficIfUnhealthy boolean,
                  :disableConnectionDrainOnFailover boolean},
 :sessionAffinity string,
 :timeoutSec integer,
 :network string,
 :backends [{:description string,
             :failover boolean,
             :capacityScaler number,
             :group string,
             :maxRatePerInstance number,
             :maxConnectionsPerEndpoint integer,
             :balancingMode string,
             :maxConnections integer,
             :maxRatePerEndpoint number,
             :maxConnectionsPerInstance integer,
             :maxUtilization number,
             :maxRate integer}],
 :customRequestHeaders [string],
 :logConfig {:enable boolean, :sampleRate number},
 :fingerprint string,
 :affinityCookieTtlSec integer,
 :securityPolicy string}

Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close