Manage addon config. This RPC is used for managing the config of the addon. Calling this RPC moves the addon into an updating state until the long-running operation succeeds.

Method Details

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Get an addon.

Args:
name: string, Required. The name of the addon to get. Format: `projects/{project}/locations/{location}/addons/{addon}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Addon resource.
"config": { # Configuration for the addon. # Required. The configuration of the addon.
"allDataAddonConfig": { # Configuration for addons which act on all data in the API hub. This is used to specify if the addon is enabled for all data in the API hub. # Configuration for addons which act on all data in the API hub.
"enabled": True or False, # Required. If true, the addon is enabled for all data in the API hub.
},
"gatewayPluginAddonConfig": { # Configuration for gateway plugin addons. This is used to specify the list of gateway plugin configs for which the addon is enabled. # Configuration for gateway plugin addons.
"gatewayPluginConfigs": [ # Required. The list of gateway plugin configs for which the addon is enabled. Each gateway plugin config should have a unique plugin instance.
{ # Configuration for a gateway plugin. This is used to specify configs for different gateways.
"apigeeEdgeConfig": { # Configuration for Apigee Edge gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance. # Configuration for Apigee Edge gateways.
"environmentFilter": { # Filter for environments. # Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
"allEnvironments": True or False, # Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
"environments": [ # Optional. If provided, only environments in this list are matched. This field is ignored if `all_environments` is true.
"A String",
],
},
},
"apigeeOpdkConfig": { # Configuration for Apigee OPDK gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance. # Configuration for Apigee OPDK gateways.
"environmentFilter": { # Filter for environments. # Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
"allEnvironments": True or False, # Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
"environments": [ # Optional. If provided, only environments in this list are matched. This field is ignored if `all_environments` is true.
"A String",
],
},
},
"apigeeXHybridConfig": { # Configuration for Apigee X and Apigee Hybrid gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance. # Configuration for Apigee X and Apigee Hybrid gateways.
"environmentFilter": { # Filter for environments. # Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
"allEnvironments": True or False, # Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
"environments": [ # Optional. If provided, only environments in this list are matched. This field is ignored if `all_environments` is true.
"A String",
],
},
},
"pluginInstance": "A String", # Required. The name of the gateway plugin instance for which the config is to be specified. Format: projects/{project}/locations/{location}/plugins/{plugin}/pluginInstances/{plugin_instance}
},
],
},
},
"createTime": "A String", # Output only. The time at which the addon was created.
"dataSource": "A String", # Required. The data source on which the addon operates. This determines which field in the `config` oneof is used.
"description": "A String", # Optional. The description of the addon.
"displayName": "A String", # Required. The display name of the addon.
"name": "A String", # Identifier. The name of the addon to enable. Format: `projects/{project}/locations/{location}/addons/{addon}`.
"state": "A String", # Output only. The state of the addon.
"updateTime": "A String", # Output only. The time at which the addon was last updated.
}

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

List addons.

Args:
parent: string, Required. The parent resource where this addon will be created. Format: `projects/{project}/locations/{location}`. (required)
filter: string, Optional. An expression that filters the list of addons. The only supported filter is `plugin_instance_name`. It can be used to filter addons that are enabled for a given plugin instance. The format of the filter is `plugin_instance_name = "projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}"`.
pageSize: integer, Optional. The maximum number of hub addons to return. The service may return fewer than this value. If unspecified, at most 50 hub addons will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListAddons` call. Provide this to retrieve the subsequent page. When paginating, all other parameters (except page_size) provided to `ListAddons` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # The ListAddons method's response.
"addons": [ # The list of addons.
{ # Addon resource.
"config": { # Configuration for the addon. # Required. The configuration of the addon.
"allDataAddonConfig": { # Configuration for addons which act on all data in the API hub. This is used to specify if the addon is enabled for all data in the API hub. # Configuration for addons which act on all data in the API hub.
"enabled": True or False, # Required. If true, the addon is enabled for all data in the API hub.
},
"gatewayPluginAddonConfig": { # Configuration for gateway plugin addons. This is used to specify the list of gateway plugin configs for which the addon is enabled. # Configuration for gateway plugin addons.
"gatewayPluginConfigs": [ # Required. The list of gateway plugin configs for which the addon is enabled. Each gateway plugin config should have a unique plugin instance.
{ # Configuration for a gateway plugin. This is used to specify configs for different gateways.
"apigeeEdgeConfig": { # Configuration for Apigee Edge gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance. # Configuration for Apigee Edge gateways.
"environmentFilter": { # Filter for environments. # Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
"allEnvironments": True or False, # Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
"environments": [ # Optional. If provided, only environments in this list are matched. This field is ignored if `all_environments` is true.
"A String",
],
},
},
"apigeeOpdkConfig": { # Configuration for Apigee OPDK gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance. # Configuration for Apigee OPDK gateways.
"environmentFilter": { # Filter for environments. # Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
"allEnvironments": True or False, # Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
"environments": [ # Optional. If provided, only environments in this list are matched. This field is ignored if `all_environments` is true.
"A String",
],
},
},
"apigeeXHybridConfig": { # Configuration for Apigee X and Apigee Hybrid gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance. # Configuration for Apigee X and Apigee Hybrid gateways.
"environmentFilter": { # Filter for environments. # Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
"allEnvironments": True or False, # Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
"environments": [ # Optional. If provided, only environments in this list are matched. This field is ignored if `all_environments` is true.
"A String",
],
},
},
"pluginInstance": "A String", # Required. The name of the gateway plugin instance for which the config is to be specified. Format: projects/{project}/locations/{location}/plugins/{plugin}/pluginInstances/{plugin_instance}
},
],
},
},
"createTime": "A String", # Output only. The time at which the addon was created.
"dataSource": "A String", # Required. The data source on which the addon operates. This determines which field in the `config` oneof is used.
"description": "A String", # Optional. The description of the addon.
"displayName": "A String", # Required. The display name of the addon.
"name": "A String", # Identifier. The name of the addon to enable. Format: `projects/{project}/locations/{location}/addons/{addon}`.
"state": "A String", # Output only. The state of the addon.
"updateTime": "A String", # Output only. The time at which the addon was last updated.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list.
}

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.

manageConfig(name, body=None, x__xgafv=None)

Manage addon config. This RPC is used for managing the config of the addon. Calling this RPC moves the addon into an updating state until the long-running operation succeeds.

Args:
name: string, Required. The name of the addon for which the config is to be managed. Format: `projects/{project}/locations/{location}/addons/{addon}`. (required)
body: object, The request body.
The object takes the form of:

{ # The ManageAddonConfig method's request.
"config": { # Configuration for the addon. # Required. The config of the addon to be managed. This config will replace the config present in the addon. The type of the config should match the config type already present in the addon.
"allDataAddonConfig": { # Configuration for addons which act on all data in the API hub. This is used to specify if the addon is enabled for all data in the API hub. # Configuration for addons which act on all data in the API hub.
"enabled": True or False, # Required. If true, the addon is enabled for all data in the API hub.
},
"gatewayPluginAddonConfig": { # Configuration for gateway plugin addons. This is used to specify the list of gateway plugin configs for which the addon is enabled. # Configuration for gateway plugin addons.
"gatewayPluginConfigs": [ # Required. The list of gateway plugin configs for which the addon is enabled. Each gateway plugin config should have a unique plugin instance.
{ # Configuration for a gateway plugin. This is used to specify configs for different gateways.
"apigeeEdgeConfig": { # Configuration for Apigee Edge gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance. # Configuration for Apigee Edge gateways.
"environmentFilter": { # Filter for environments. # Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
"allEnvironments": True or False, # Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
"environments": [ # Optional. If provided, only environments in this list are matched. This field is ignored if `all_environments` is true.
"A String",
],
},
},
"apigeeOpdkConfig": { # Configuration for Apigee OPDK gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance. # Configuration for Apigee OPDK gateways.
"environmentFilter": { # Filter for environments. # Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
"allEnvironments": True or False, # Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
"environments": [ # Optional. If provided, only environments in this list are matched. This field is ignored if `all_environments` is true.
"A String",
],
},
},
"apigeeXHybridConfig": { # Configuration for Apigee X and Apigee Hybrid gateways. Applicability of a filter is determined by the filter being provided. If none of the filters are provided the addon will be enabled for all data brought in by the gateway plugin instance. # Configuration for Apigee X and Apigee Hybrid gateways.
"environmentFilter": { # Filter for environments. # Optional. The filter to apply on the resources managed by the gateway plugin instance. If provided this filter applies environment specific filtering.
"allEnvironments": True or False, # Optional. Indicates if this filter should match all environments or only a subset of environments. If set to true, all environments are matched.
"environments": [ # Optional. If provided, only environments in this list are matched. This field is ignored if `all_environments` is true.
"A String",
],
},
},
"pluginInstance": "A String", # Required. The name of the gateway plugin instance for which the config is to be specified. Format: projects/{project}/locations/{location}/plugins/{plugin}/pluginInstances/{plugin_instance}
},
],
},
},
}

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.
},
}

API hub API . projects . locations . addons

Instance Methods

Method Details