close()

Close httplib2 connections.

create(parent, body=None, serviceLbPolicyId=None, x__xgafv=None)

Creates a new ServiceLbPolicy in a given project and location.

Args:
parent: string, Required. The parent resource of the ServiceLbPolicy. Must be in the format `projects/{project}/locations/{location}`. (required)
body: object, The request body.
The object takes the form of:

{ # ServiceLbPolicy holds global load balancing and traffic distribution configuration that can be applied to a BackendService.
"autoCapacityDrain": { # Option to specify if an unhealthy IG/NEG should be considered for global load balancing and traffic routing. # Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
"enable": True or False, # Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.
},
"createTime": "A String", # Output only. The timestamp when this resource was created.
"description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
"failoverConfig": { # Option to specify health based failover behavior. This is not related to Network load balancer FailoverPolicy. # Optional. Configuration related to health based failover.
"failoverHealthThreshold": 42, # Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.
},
"labels": { # Optional. Set of label tags associated with the ServiceLbPolicy resource.
"a_key": "A String",
},
"loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
"name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.
"updateTime": "A String", # Output only. The timestamp when this resource was last updated.
}

serviceLbPolicyId: string, Required. Short name of the ServiceLbPolicy resource to be created. E.g. for resource name `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. the id is value of {service_lb_policy_name}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

delete(name, x__xgafv=None)

Deletes a single ServiceLbPolicy.

Args:
name: string, Required. A name of the ServiceLbPolicy to delete. Must be in the format `projects/{project}/locations/{location}/serviceLbPolicies/*`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets details of a single ServiceLbPolicy.

Args:
  name: string, Required. A name of the ServiceLbPolicy to get. Must be in the format `projects/{project}/locations/{location}/serviceLbPolicies/*`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ServiceLbPolicy holds global load balancing and traffic distribution configuration that can be applied to a BackendService.
  "autoCapacityDrain": { # Option to specify if an unhealthy IG/NEG should be considered for global load balancing and traffic routing. # Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
    "enable": True or False, # Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.
  },
  "createTime": "A String", # Output only. The timestamp when this resource was created.
  "description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
  "failoverConfig": { # Option to specify health based failover behavior. This is not related to Network load balancer FailoverPolicy. # Optional. Configuration related to health based failover.
    "failoverHealthThreshold": 42, # Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.
  },
  "labels": { # Optional. Set of label tags associated with the ServiceLbPolicy resource.
    "a_key": "A String",
  },
  "loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
  "name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.
  "updateTime": "A String", # Output only. The timestamp when this resource was last updated.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists ServiceLbPolicies in a given project and location.

Args:
parent: string, Required. The project and location from which the ServiceLbPolicies should be listed, specified in the format `projects/{project}/locations/{location}`. (required)
pageSize: integer, Maximum number of ServiceLbPolicies to return per call.
pageToken: string, The value returned by the last `ListServiceLbPoliciesResponse` Indicates that this is a continuation of a prior `ListRouters` call, and that the system should return the next page of data.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response returned by the ListServiceLbPolicies method.
"nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
"serviceLbPolicies": [ # List of ServiceLbPolicy resources.
{ # ServiceLbPolicy holds global load balancing and traffic distribution configuration that can be applied to a BackendService.
"autoCapacityDrain": { # Option to specify if an unhealthy IG/NEG should be considered for global load balancing and traffic routing. # Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
"enable": True or False, # Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.
},
"createTime": "A String", # Output only. The timestamp when this resource was created.
"description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
"failoverConfig": { # Option to specify health based failover behavior. This is not related to Network load balancer FailoverPolicy. # Optional. Configuration related to health based failover.
"failoverHealthThreshold": 42, # Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.
},
"labels": { # Optional. Set of label tags associated with the ServiceLbPolicy resource.
"a_key": "A String",
},
"loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
"name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.
"updateTime": "A String", # Output only. The timestamp when this resource was last updated.
},
],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single ServiceLbPolicy.

Args:
name: string, Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`. (required)
body: object, The request body.
The object takes the form of:

{ # ServiceLbPolicy holds global load balancing and traffic distribution configuration that can be applied to a BackendService.
"autoCapacityDrain": { # Option to specify if an unhealthy IG/NEG should be considered for global load balancing and traffic routing. # Optional. Configuration to automatically move traffic away for unhealthy IG/NEG for the associated Backend Service.
"enable": True or False, # Optional. If set to 'True', an unhealthy IG/NEG will be set as drained. - An IG/NEG is considered unhealthy if less than 25% of the instances/endpoints in the IG/NEG are healthy. - This option will never result in draining more than 50% of the configured IGs/NEGs for the Backend Service.
},
"createTime": "A String", # Output only. The timestamp when this resource was created.
"description": "A String", # Optional. A free-text description of the resource. Max length 1024 characters.
"failoverConfig": { # Option to specify health based failover behavior. This is not related to Network load balancer FailoverPolicy. # Optional. Configuration related to health based failover.
"failoverHealthThreshold": 42, # Optional. The percentage threshold that a load balancer will begin to send traffic to failover backends. If the percentage of endpoints in a MIG/NEG is smaller than this value, traffic would be sent to failover backends if possible. This field should be set to a value between 1 and 99. The default value is 50 for Global external HTTP(S) load balancer (classic) and Proxyless service mesh, and 70 for others.
},
"labels": { # Optional. Set of label tags associated with the ServiceLbPolicy resource.
"a_key": "A String",
},
"loadBalancingAlgorithm": "A String", # Optional. The type of load balancing algorithm to be used. The default behavior is WATERFALL_BY_REGION.
"name": "A String", # Identifier. Name of the ServiceLbPolicy resource. It matches pattern `projects/{project}/locations/{location}/serviceLbPolicies/{service_lb_policy_name}`.
"updateTime": "A String", # Output only. The timestamp when this resource was last updated.
}

updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the ServiceLbPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

Network Services API . projects . locations . serviceLbPolicies

Instance Methods

Method Details