close()

Close httplib2 connections.

create(parent, body=None, multicastGroupConsumerActivationId=None, requestId=None, x__xgafv=None)

Creates a new multicast group consumer activation in a given project and location.

Args:
parent: string, Required. The parent resource of the multicast group consumer activation. Use the following format: `projects/*/locations/*`. (required)
body: object, The request body.
The object takes the form of:

{ # Multicast group consumer activation resource.
"createTime": "A String", # Output only. [Output only] The timestamp when the multicast group consumer activation was created.
"description": "A String", # Optional. An optional text description of the multicast group consumer activation.
"labels": { # Optional. Labels as key-value pairs
"a_key": "A String",
},
"logConfig": { # The logging configuration. # Optional. Specifies the logging options for the activities performed related to the multicast group consumer activation. Defaults to false. If logging is enabled, logs are exported to Cloud Logging.
"enabled": True or False, # Optional. Whether to enable logging or not.
},
"multicastConsumerAssociation": "A String", # Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.
"multicastGroup": "A String", # Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead.
"multicastGroupRangeActivation": "A String", # Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroupRangeActivations/*`.
"name": "A String", # Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`.
"resourceState": "A String", # Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead.
"state": { # The multicast resource's state. # Output only. [Output only] The state of the resource.
"state": "A String", # Optional. The state of the multicast resource.
},
"uniqueId": "A String", # Output only. [Output only] The Google-generated UUID for the resource. This value is unique across all multicast group consumer activation resources. If a group consumer activation is deleted and another with the same name is created, the new group consumer activation is assigned a different unique_id.
"updateTime": "A String", # Output only. [Output only] The timestamp when the multicast group consumer activation was most recently updated.
}

multicastGroupConsumerActivationId: string, Required. A unique name for the multicast group consumer activation. The name is restricted to lower-case letters, numbers, and hyphen, with the first character a lower-case letter, and the last a letter or a number. The name must not exceed 48 characters.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
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, requestId=None, x__xgafv=None)

Deletes a single multicast group consumer activation.

Args:
name: string, Required. The resource name of the multicast group consumer activation to delete. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`. (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
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 multicast group consumer activation.

Args:
name: string, Required. The resource name of the multicast group consumer activation to get. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Multicast group consumer activation resource.
"createTime": "A String", # Output only. [Output only] The timestamp when the multicast group consumer activation was created.
"description": "A String", # Optional. An optional text description of the multicast group consumer activation.
"labels": { # Optional. Labels as key-value pairs
"a_key": "A String",
},
"logConfig": { # The logging configuration. # Optional. Specifies the logging options for the activities performed related to the multicast group consumer activation. Defaults to false. If logging is enabled, logs are exported to Cloud Logging.
"enabled": True or False, # Optional. Whether to enable logging or not.
},
"multicastConsumerAssociation": "A String", # Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.
"multicastGroup": "A String", # Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead.
"multicastGroupRangeActivation": "A String", # Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroupRangeActivations/*`.
"name": "A String", # Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`.
"resourceState": "A String", # Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead.
"state": { # The multicast resource's state. # Output only. [Output only] The state of the resource.
"state": "A String", # Optional. The state of the multicast resource.
},
"uniqueId": "A String", # Output only. [Output only] The Google-generated UUID for the resource. This value is unique across all multicast group consumer activation resources. If a group consumer activation is deleted and another with the same name is created, the new group consumer activation is assigned a different unique_id.
"updateTime": "A String", # Output only. [Output only] The timestamp when the multicast group consumer activation was most recently updated.
}

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

Lists multicast group consumer activations in a given project and location.

Args:
parent: string, Required. The parent resource for which to list multicast group consumer activations. Use the following format: `projects/*/locations/*`. (required)
filter: string, Optional. A filter expression that filters the resources listed in the response. The expression must be of the form ` ` where operators: `<`, `>`, `<=`, `>=`, `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is roughly synonymous with equality). can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: * Filter by name: name = "RESOURCE_NAME" * Filter by labels: * Resources that have a key named `foo` labels.foo:* * Resources that have a key named `foo` whose value is `bar` labels.foo = bar
orderBy: string, Optional. A field used to sort the results by a certain order.
pageSize: integer, Optional. The maximum number of multicast group consumer activations to return per call.
pageToken: string, Optional. A page token from an earlier query, as returned in `next_page_token`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for ListMulticastGroupConsumerActivations.
"multicastGroupConsumerActivations": [ # The list of multicast group consumer activations.
{ # Multicast group consumer activation resource.
"createTime": "A String", # Output only. [Output only] The timestamp when the multicast group consumer activation was created.
"description": "A String", # Optional. An optional text description of the multicast group consumer activation.
"labels": { # Optional. Labels as key-value pairs
"a_key": "A String",
},
"logConfig": { # The logging configuration. # Optional. Specifies the logging options for the activities performed related to the multicast group consumer activation. Defaults to false. If logging is enabled, logs are exported to Cloud Logging.
"enabled": True or False, # Optional. Whether to enable logging or not.
},
"multicastConsumerAssociation": "A String", # Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.
"multicastGroup": "A String", # Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead.
"multicastGroupRangeActivation": "A String", # Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroupRangeActivations/*`.
"name": "A String", # Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`.
"resourceState": "A String", # Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead.
"state": { # The multicast resource's state. # Output only. [Output only] The state of the resource.
"state": "A String", # Optional. The state of the multicast resource.
},
"uniqueId": "A String", # Output only. [Output only] The Google-generated UUID for the resource. This value is unique across all multicast group consumer activation resources. If a group consumer activation is deleted and another with the same name is created, the new group consumer activation is assigned a different unique_id.
"updateTime": "A String", # Output only. [Output only] The timestamp when the multicast group consumer activation was most recently updated.
},
],
"nextPageToken": "A String", # A page token from an earlier query, as returned in `next_page_token`.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}

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, requestId=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single multicast group consumer activation.

Args:
name: string, Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`. (required)
body: object, The request body.
The object takes the form of:

{ # Multicast group consumer activation resource.
"createTime": "A String", # Output only. [Output only] The timestamp when the multicast group consumer activation was created.
"description": "A String", # Optional. An optional text description of the multicast group consumer activation.
"labels": { # Optional. Labels as key-value pairs
"a_key": "A String",
},
"logConfig": { # The logging configuration. # Optional. Specifies the logging options for the activities performed related to the multicast group consumer activation. Defaults to false. If logging is enabled, logs are exported to Cloud Logging.
"enabled": True or False, # Optional. Whether to enable logging or not.
},
"multicastConsumerAssociation": "A String", # Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.
"multicastGroup": "A String", # Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead.
"multicastGroupRangeActivation": "A String", # Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: // `projects/*/locations/*/multicastGroupRangeActivations/*`.
"name": "A String", # Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`.
"resourceState": "A String", # Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead.
"state": { # The multicast resource's state. # Output only. [Output only] The state of the resource.
"state": "A String", # Optional. The state of the multicast resource.
},
"uniqueId": "A String", # Output only. [Output only] The Google-generated UUID for the resource. This value is unique across all multicast group consumer activation resources. If a group consumer activation is deleted and another with the same name is created, the new group consumer activation is assigned a different unique_id.
"updateTime": "A String", # Output only. [Output only] The timestamp when the multicast group consumer activation was most recently updated.
}

requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the MulticastGroupConsumerActivation 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 mutable fields present in the request 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 . multicastGroupConsumerActivations

Instance Methods

Method Details