- measurementProtocolSecrets()
-
Returns the measurementProtocolSecrets Resource.
-Close httplib2 connections.
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html index 4f133330802..c12ffaf2976 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html @@ -91,6 +91,9 @@Lookup for a single DataStream.
+
+ getGlobalSiteTag(name, x__xgafv=None)
Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists DataStreams on a property.
@@ -220,6 +223,26 @@getGlobalSiteTag(name, x__xgafv=None)
+ Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
+
+Args:
+ name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag" (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Read-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources.
+ "name": "A String", # Output only. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag"
+ "snippet": "A String", # Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists DataStreams on a property. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.html b/docs/dyn/analyticsadmin_v1alpha.properties.html index 944226338ea..19bf3892ce4 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.html @@ -74,6 +74,11 @@Google Analytics Admin API . properties
Instance Methods
+ +Returns the androidAppDataStreams Resource.
+ @@ -114,6 +119,11 @@Instance Methods
Returns the googleAdsLinks Resource.
+ +Returns the iosAppDataStreams Resource.
+ @@ -345,7 +355,7 @@Method Details
Returns child Properties under the specified parent Account. Only "GA4" properties will be returned. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found. Args: - filter: string, Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ``` + filter: string, Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ``` pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) pageToken: string, A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html index 15b88c59791..d6c735946d5 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.iosAppDataStreams.html @@ -74,11 +74,6 @@Google Analytics Admin API . properties . iosAppDataStreams
Instance Methods
--
-measurementProtocolSecrets()-Returns the measurementProtocolSecrets Resource.
-Close httplib2 connections.
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html index adaa0cf5ad3..be136f2495c 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.webDataStreams.html @@ -78,8 +78,23 @@Instance Methods
close()Close httplib2 connections.
-
-getGlobalSiteTag(name, x__xgafv=None)Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
+create(parent, body=None, x__xgafv=None)+Creates a web stream with the specified location and attributes.
+ +Deletes a web stream on a property.
+ +Lookup for a single WebDataStream
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.
++
+list_next(previous_request, previous_response)Retrieves the next page of results.
++
+patch(name, body=None, updateMask=None, x__xgafv=None)Updates a web stream on a property.
Method Details
close()@@ -87,11 +102,152 @@Method Details
-+ +getGlobalSiteTag(name, x__xgafv=None)-Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. +create(parent, body=None, x__xgafv=None)+Creates a web stream with the specified location and attributes. + +Args: + parent: string, Required. The parent resource where this web data stream will be created. Format: properties/123 (required) + body: object, The request body. + The object takes the form of: + +{ # A resource message representing a Google Analytics web stream. + "createTime": "A String", # Output only. Time when this stream was originally created. + "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" + "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. + "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. + "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" + "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" + "updateTime": "A String", # Output only. Time when stream payload fields were last updated. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A resource message representing a Google Analytics web stream. + "createTime": "A String", # Output only. Time when this stream was originally created. + "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" + "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. + "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. + "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" + "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" + "updateTime": "A String", # Output only. Time when stream payload fields were last updated. +}+++ +delete(name, x__xgafv=None)+Deletes a web stream on a property. + +Args: + name: string, Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456" (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. +}+++ +get(name, x__xgafv=None)+Lookup for a single WebDataStream + +Args: + name: string, Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/123/webDataStreams/456" (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A resource message representing a Google Analytics web stream. + "createTime": "A String", # Output only. Time when this stream was originally created. + "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" + "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. + "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. + "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" + "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" + "updateTime": "A String", # Output only. Time when stream payload fields were last updated. +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found. Args: - name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/webDataStreams/{stream_id}/globalSiteTag Example: "properties/123/webDataStreams/456/globalSiteTag" (required) + parent: string, Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: "properties/123" (required) + pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + pageToken: string, A page token, received from a previous `ListWebDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebDataStreams` 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: + + { # Request message for ListWebDataStreams RPC. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "webDataStreams": [ # Results that matched the filter criteria and were accessible to the caller. + { # A resource message representing a Google Analytics web stream. + "createTime": "A String", # Output only. Time when this stream was originally created. + "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" + "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. + "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. + "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" + "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" + "updateTime": "A String", # Output only. Time when stream payload fields were last updated. + }, + ], +}+++ +list_next(previous_request, previous_response)+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. +++diff --git a/docs/dyn/androidmanagement_v1.enterprises.webApps.html b/docs/dyn/androidmanagement_v1.enterprises.webApps.html index 61e1f46c086..d2e59a443df 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.webApps.html +++ b/docs/dyn/androidmanagement_v1.enterprises.webApps.html @@ -197,7 +197,7 @@patch(name, body=None, updateMask=None, x__xgafv=None)+Updates a web stream on a property. + +Args: + name: string, Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" (required) + body: object, The request body. + The object takes the form of: + +{ # A resource message representing a Google Analytics web stream. + "createTime": "A String", # Output only. Time when this stream was originally created. + "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" + "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. + "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. + "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" + "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" + "updateTime": "A String", # Output only. Time when stream payload fields were last updated. +} + + updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -100,9 +256,14 @@Method Details
Returns: An object of the form: - { # Read-only resource with the tag for sending data from a website to a WebDataStream. - "name": "A String", # Output only. Resource name for this GlobalSiteTag resource. Format: properties/{propertyId}/globalSiteTag - "snippet": "A String", # Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure. + { # A resource message representing a Google Analytics web stream. + "createTime": "A String", # Output only. Time when this stream was originally created. + "defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com" + "displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units. + "firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. + "measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E" + "name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000" + "updateTime": "A String", # Output only. Time when stream payload fields were last updated. }Method Details
Args: parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required) - pageSize: integer, The requested page size. The actual page size may be fixed to a min or max value. + pageSize: integer, The requested page size. This is a hint and the actual page size in the response may be different. pageToken: string, A token identifying a page of results returned by the server. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/androidpublisher_v3.edits.tracks.html b/docs/dyn/androidpublisher_v3.edits.tracks.html index 8f85d12c518..2c2485c6708 100644 --- a/docs/dyn/androidpublisher_v3.edits.tracks.html +++ b/docs/dyn/androidpublisher_v3.edits.tracks.html @@ -123,7 +123,7 @@Method Details
"inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates. "name": "A String", # The release name. Not required to be unique. If not set, the name is generated from the APK's version_name. If the release contains multiple APKs, the name is generated from the date. "releaseNotes": [ # A description of what is new in this release. - { # Release notes specification, i.e. language and text. + { # Localized text in given language. "language": "A String", # Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). "text": "A String", # The text in the given language. }, @@ -169,7 +169,7 @@Method Details
"inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates. "name": "A String", # The release name. Not required to be unique. If not set, the name is generated from the APK's version_name. If the release contains multiple APKs, the name is generated from the date. "releaseNotes": [ # A description of what is new in this release. - { # Release notes specification, i.e. language and text. + { # Localized text in given language. "language": "A String", # Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). "text": "A String", # The text in the given language. }, @@ -210,7 +210,7 @@Method Details
"inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates. "name": "A String", # The release name. Not required to be unique. If not set, the name is generated from the APK's version_name. If the release contains multiple APKs, the name is generated from the date. "releaseNotes": [ # A description of what is new in this release. - { # Release notes specification, i.e. language and text. + { # Localized text in given language. "language": "A String", # Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). "text": "A String", # The text in the given language. }, @@ -245,7 +245,7 @@Method Details
"inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates. "name": "A String", # The release name. Not required to be unique. If not set, the name is generated from the APK's version_name. If the release contains multiple APKs, the name is generated from the date. "releaseNotes": [ # A description of what is new in this release. - { # Release notes specification, i.e. language and text. + { # Localized text in given language. "language": "A String", # Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). "text": "A String", # The text in the given language. }, @@ -284,7 +284,7 @@Method Details
"inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates. "name": "A String", # The release name. Not required to be unique. If not set, the name is generated from the APK's version_name. If the release contains multiple APKs, the name is generated from the date. "releaseNotes": [ # A description of what is new in this release. - { # Release notes specification, i.e. language and text. + { # Localized text in given language. "language": "A String", # Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). "text": "A String", # The text in the given language. }, @@ -319,7 +319,7 @@Method Details
"inAppUpdatePriority": 42, # In-app update priority of the release. All newly added APKs in the release will be considered at this priority. Can take values in the range [0, 5], with 5 the highest priority. Defaults to 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates. "name": "A String", # The release name. Not required to be unique. If not set, the name is generated from the APK's version_name. If the release contains multiple APKs, the name is generated from the date. "releaseNotes": [ # A description of what is new in this release. - { # Release notes specification, i.e. language and text. + { # Localized text in given language. "language": "A String", # Language localization code (a BCP-47 language tag; for example, "de-AT" for Austrian German). "text": "A String", # The text in the given language. }, diff --git a/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.html b/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.html index be84b9fd146..d67df83deac 100644 --- a/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.html +++ b/docs/dyn/apigee_v1.organizations.apis.keyvaluemaps.html @@ -79,10 +79,10 @@Instance Methods
Close httplib2 connections.
-
create(parent, body=None, x__xgafv=None)Creates a key value map in an api proxy.
+Creates a key value map in an API proxy.
-Delete a key value map in an api proxy.
+Deletes a key value map from an API proxy.
Method Details
close()@@ -91,16 +91,16 @@Method Details
create(parent, body=None, x__xgafv=None)-Creates a key value map in an api proxy. +Creates a key value map in an API proxy. Args: - parent: string, Required. The name of the environment in which to create the key value map. Must be of the form `organizations/{organization}/apis/{api}`. (required) + parent: string, Required. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}` (required) body: object, The request body. The object takes the form of: -{ # A collection of key, value string pairs - "encrypted": True or False, # Optional. If `true` entry values will be encrypted. - "name": "A String", # Required. The id of the key value map. +{ # Collection of key/value string pairs. + "encrypted": True or False, # Optional. Flag that specifies whether entry values will be encrypted. Enable to encrypt entry values. + "name": "A String", # Required. ID of the key value map. } x__xgafv: string, V1 error format. @@ -111,18 +111,18 @@Method Details
Returns: An object of the form: - { # A collection of key, value string pairs - "encrypted": True or False, # Optional. If `true` entry values will be encrypted. - "name": "A String", # Required. The id of the key value map. + { # Collection of key/value string pairs. + "encrypted": True or False, # Optional. Flag that specifies whether entry values will be encrypted. Enable to encrypt entry values. + "name": "A String", # Required. ID of the key value map. }diff --git a/docs/dyn/apigee_v1.organizations.developers.balance.html b/docs/dyn/apigee_v1.organizations.developers.balance.html index 63a97f541c6..f65beff1084 100644 --- a/docs/dyn/apigee_v1.organizations.developers.balance.html +++ b/docs/dyn/apigee_v1.organizations.developers.balance.html @@ -94,7 +94,7 @@delete(name, x__xgafv=None)-Delete a key value map in an api proxy. +Deletes a key value map from an API proxy. Args: - name: string, Required. The name of the key value map. Must be of the form `organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}`. (required) + name: string, Required. Name of the key value map. Use the following structure in your request: `organizations/{org}/apis/{api}/keyvaluemaps/{keyvaluemap}` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -131,9 +131,9 @@Method Details
Returns: An object of the form: - { # A collection of key, value string pairs - "encrypted": True or False, # Optional. If `true` entry values will be encrypted. - "name": "A String", # Required. The id of the key value map. + { # Collection of key/value string pairs. + "encrypted": True or False, # Optional. Flag that specifies whether entry values will be encrypted. Enable to encrypt entry values. + "name": "A String", # Required. ID of the key value map. }Method Details
The object takes the form of: { # Request for AdjustDeveloperBalance. - "adjustment": { # Represents an amount of money with its currency type. # * A positive value of `adjustment` means that that the API provider wishes to adjust the balance for an over-charged developer i.e. the balance of the developer will increase. * A negative value of `adjustment` means that that the API provider wishes to adjust the balance for an under-charged developer i.e. the balance of the developer will decrease. + "adjustment": { # Represents an amount of money with its currency type. # * A positive value of `adjustment` means that that the API provider wants to adjust the balance for an under-charged developer i.e. the balance of the developer will decrease. * A negative value of `adjustment` means that that the API provider wants to adjust the balance for an over-charged developer i.e. the balance of the developer will increase. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. diff --git a/docs/dyn/apigee_v1.organizations.endpointAttachments.html b/docs/dyn/apigee_v1.organizations.endpointAttachments.html new file mode 100644 index 00000000000..5fdbf89adf7 --- /dev/null +++ b/docs/dyn/apigee_v1.organizations.endpointAttachments.html @@ -0,0 +1,247 @@ + + + +Apigee API . organizations . endpointAttachments
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, endpointAttachmentId=None, x__xgafv=None)Creates an EndpointAttachment. **Note:** Not supported for Apigee hybrid.
+ +Deletes an endpoint attachment.
+ +Gets the specified EndpointAttachment.
++
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists the EndpointAttachments in the specified Organization.
++
+list_next(previous_request, previous_response)Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, endpointAttachmentId=None, x__xgafv=None)+Creates an EndpointAttachment. **Note:** Not supported for Apigee hybrid. + +Args: + parent: string, Required. The Organization this EndpointAttachment will be created in. (required) + body: object, The request body. + The object takes the form of: + +{ # Apigee Endpoint Attachment. + "host": "A String", # Output only. Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server. + "location": "A String", # Required. Location of the endpoint attachment. + "name": "A String", # Name of the Endpoint Attachment in the following format: `organizations/{organization}/endpointAttachments/{endpoint_attachment}`. + "serviceAttachment": "A String", # Format: projects/*/regions/*/serviceAttachments/* +} + + endpointAttachmentId: string, The ID to use for the endpoint attachment. ID must be a 1-20 characters string with lowercase letters and numbers and must start with a letter. + 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 response of the operation in case of success. 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 an endpoint attachment. + +Args: + name: string, Required. Name of the Endpoint Attachment in the following format: `organizations/{organization}/endpointAttachments/{endpoint_attachment}`. (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 response of the operation in case of success. 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 the specified EndpointAttachment. + +Args: + name: string, Required. Name of the Endpoint Attachment in the following format: `organizations/{organization}/endpointAttachments/{endpoint_attachment}`. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Apigee Endpoint Attachment. + "host": "A String", # Output only. Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server. + "location": "A String", # Required. Location of the endpoint attachment. + "name": "A String", # Name of the Endpoint Attachment in the following format: `organizations/{organization}/endpointAttachments/{endpoint_attachment}`. + "serviceAttachment": "A String", # Format: projects/*/regions/*/serviceAttachments/* +}+++ +list(parent, pageSize=None, pageToken=None, x__xgafv=None)+Lists the EndpointAttachments in the specified Organization. + +Args: + parent: string, Required. Name of the Organization for which to list Endpoint Attachments in the format: `organizations/{organization}`. (required) + pageSize: integer, Optional. Maximum number of Endpoint Attachments to return. If unspecified, at most 25 attachments will be returned. + pageToken: string, Optional. Page token, returned from a previous ListEndpointAttachments call, that you can use to retrieve the next page. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for ListEndpointAttachments method. + "endpointAttachments": [ # Endpoint Attachments in the specified organization. + { # Apigee Endpoint Attachment. + "host": "A String", # Output only. Host that can be used in either HTTP Target Endpoint directly, or as the host in Target Server. + "location": "A String", # Required. Location of the endpoint attachment. + "name": "A String", # Name of the Endpoint Attachment in the following format: `organizations/{organization}/endpointAttachments/{endpoint_attachment}`. + "serviceAttachment": "A String", # Format: projects/*/regions/*/serviceAttachments/* + }, + ], + "nextPageToken": "A String", # Page token that you can include in a ListEndpointAttachments request to retrieve the next page. If omitted, no subsequent pages exist. +}+++ + \ No newline at end of file diff --git a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.html b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.html index 913799663d1..afb81cfa889 100644 --- a/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.html +++ b/docs/dyn/apigee_v1.organizations.environments.apis.revisions.debugsessions.html @@ -114,6 +114,7 @@list_next(previous_request, previous_response)+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. ++Method Details
{ "count": 42, # Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10. + "createTime": "A String", # Output only. The first transaction creation timestamp, recorded by UAP. "filter": "A String", # Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition. "name": "A String", # A unique ID for this DebugSession. "timeout": "A String", # Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided. @@ -132,6 +133,7 @@Method Details
{ "count": 42, # Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10. + "createTime": "A String", # Output only. The first transaction creation timestamp, recorded by UAP. "filter": "A String", # Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition. "name": "A String", # A unique ID for this DebugSession. "timeout": "A String", # Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided. @@ -174,6 +176,7 @@Method Details
{ "count": 42, # Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10. + "createTime": "A String", # Output only. The first transaction creation timestamp, recorded by UAP. "filter": "A String", # Optional. A conditional statement which is evaluated against the request message to determine if it should be traced. Syntax matches that of on API Proxy bundle flow Condition. "name": "A String", # A unique ID for this DebugSession. "timeout": "A String", # Optional. The time in seconds after which this DebugSession should end. This value will override the value in query param, if both are provided. @@ -203,7 +206,7 @@Method Details
"sessions": [ # Session info that includes debug session ID and the first transaction creation timestamp. { # Session carries the debug session id and its creation time. "id": "A String", # The debug session ID. - "timestampMs": "A String", # The first transaction creation timestamp in millisecond, recoreded by UAP. + "timestampMs": "A String", # The first transaction creation timestamp in millisecond, recorded by UAP. }, ], } diff --git a/docs/dyn/apigee_v1.organizations.environments.html b/docs/dyn/apigee_v1.organizations.environments.html index 3f3c6c9e2e9..3cd9e9cf968 100644 --- a/docs/dyn/apigee_v1.organizations.environments.html +++ b/docs/dyn/apigee_v1.organizations.environments.html @@ -192,13 +192,13 @@Instance Methods
Deletes a subscription for the environment's Pub/Sub topic.
-
update(name, body=None, x__xgafv=None)Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).
+Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment.
updateDebugmask(name, body=None, replaceRepeatedFields=None, updateMask=None, x__xgafv=None)Updates the debug mask singleton resource for an environment.
-
updateEnvironment(name, body=None, x__xgafv=None)Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get).
+Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment.
updateTraceConfig(name, body=None, updateMask=None, x__xgafv=None)Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.
@@ -772,7 +772,7 @@Method Details
update(name, body=None, x__xgafv=None)-Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). +Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment. Args: name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required) @@ -904,7 +904,7 @@Method Details
updateEnvironment(name, body=None, x__xgafv=None)-Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). +Updates an existing environment. When updating properties, you must pass all existing properties to the API, even if they are not being changed. If you omit properties from the payload, the properties are removed. To get the current list of properties for the environment, use the [Get Environment API](get). **Note**: Both `PUT` and `POST` methods are supported for updating an existing environment. Args: name: string, Required. Name of the environment. Use the following structure in your request: `organizations/{org}/environments/{env}` (required) diff --git a/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.html b/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.html index 102407a0610..36a337c72c0 100644 --- a/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.html +++ b/docs/dyn/apigee_v1.organizations.environments.keyvaluemaps.html @@ -82,7 +82,7 @@Instance Methods
Creates a key value map in an environment.
-Delete a key value map in an environment.
+Deletes a key value map from an environment.
Method Details
close()@@ -94,13 +94,13 @@Method Details
Creates a key value map in an environment. Args: - parent: string, Required. The name of the environment in which to create the key value map. Must be of the form `organizations/{organization}/environments/{environment}`. (required) + parent: string, Required. Name of the environment in which to create the key value map. Use the following structure in your request: `organizations/{org}/environments/{env}` (required) body: object, The request body. The object takes the form of: -{ # A collection of key, value string pairs - "encrypted": True or False, # Optional. If `true` entry values will be encrypted. - "name": "A String", # Required. The id of the key value map. +{ # Collection of key/value string pairs. + "encrypted": True or False, # Optional. Flag that specifies whether entry values will be encrypted. Enable to encrypt entry values. + "name": "A String", # Required. ID of the key value map. } x__xgafv: string, V1 error format. @@ -111,18 +111,18 @@Method Details
Returns: An object of the form: - { # A collection of key, value string pairs - "encrypted": True or False, # Optional. If `true` entry values will be encrypted. - "name": "A String", # Required. The id of the key value map. + { # Collection of key/value string pairs. + "encrypted": True or False, # Optional. Flag that specifies whether entry values will be encrypted. Enable to encrypt entry values. + "name": "A String", # Required. ID of the key value map. }diff --git a/docs/dyn/apigee_v1.organizations.environments.targetservers.html b/docs/dyn/apigee_v1.organizations.environments.targetservers.html index 70e45dff76e..2f68ffc2631 100644 --- a/docs/dyn/apigee_v1.organizations.environments.targetservers.html +++ b/docs/dyn/apigee_v1.organizations.environments.targetservers.html @@ -111,7 +111,7 @@delete(name, x__xgafv=None)-Delete a key value map in an environment. +Deletes a key value map from an environment. Args: - name: string, Required. The name of the key value map. Must be of the form `organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}`. (required) + name: string, Required. Name of the key value map. Use the following structure in your request: `organizations/{org}/environments/{env}/keyvaluemaps/{keyvaluemap}` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -131,9 +131,9 @@Method Details
Returns: An object of the form: - { # A collection of key, value string pairs - "encrypted": True or False, # Optional. If `true` entry values will be encrypted. - "name": "A String", # Required. The id of the key value map. + { # Collection of key/value string pairs. + "encrypted": True or False, # Optional. Flag that specifies whether entry values will be encrypted. Enable to encrypt entry values. + "name": "A String", # Required. ID of the key value map. }Method Details
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. "protocol": "A String", # Immutable. The protocol used by this TargetServer. - "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. + "sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", ], @@ -147,7 +147,7 @@Method Details
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. "protocol": "A String", # Immutable. The protocol used by this TargetServer. - "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. + "sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", ], @@ -189,7 +189,7 @@Method Details
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. "protocol": "A String", # Immutable. The protocol used by this TargetServer. - "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. + "sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", ], @@ -231,7 +231,7 @@Method Details
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. "protocol": "A String", # Immutable. The protocol used by this TargetServer. - "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. + "sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", ], @@ -268,7 +268,7 @@Method Details
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. "protocol": "A String", # Immutable. The protocol used by this TargetServer. - "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. + "sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", ], @@ -303,7 +303,7 @@Method Details
"name": "A String", # Required. The resource id of this target server. Values must match the regular expression "port": 42, # Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. "protocol": "A String", # Immutable. The protocol used by this TargetServer. - "sSLInfo": { # TLS configuration information for VirtualHosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. + "sSLInfo": { # TLS configuration information for virtual hosts and TargetServers. # Optional. Specifies TLS configuration info for this TargetServer. The JSON name is `sSLInfo` for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration. "ciphers": [ # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites "A String", ], diff --git a/docs/dyn/apigee_v1.organizations.html b/docs/dyn/apigee_v1.organizations.html index 4d952b25589..b7de79255aa 100644 --- a/docs/dyn/apigee_v1.organizations.html +++ b/docs/dyn/apigee_v1.organizations.html @@ -109,6 +109,11 @@Instance Methods
Returns the developers Resource.
+ +Returns the endpointAttachments Resource.
+ diff --git a/docs/dyn/apigee_v1.organizations.instances.html b/docs/dyn/apigee_v1.organizations.instances.html index 6bbf0984a60..db07503e29b 100644 --- a/docs/dyn/apigee_v1.organizations.instances.html +++ b/docs/dyn/apigee_v1.organizations.instances.html @@ -134,6 +134,7 @@Method Details
"diskEncryptionKeyName": "A String", # Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` "displayName": "A String", # Optional. Display name for the instance. "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. + "ipRange": "A String", # Optional. IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation. This optional range, if provided, should be freely available as part of larger named range the customer has allocated to the Service Networking peering. If this is not provided, Apigee will automatically request for any available /22 CIDR block from Service Networking. The customer should use this CIDR block for configuring their firewall needs to allow traffic from Apigee. Input format: "a.b.c.d/22", Output format: a.b.c.d/22, e.f.g.h/28" "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. "location": "A String", # Required. Compute Engine location where the instance resides. "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. @@ -227,6 +228,7 @@Method Details
"diskEncryptionKeyName": "A String", # Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` "displayName": "A String", # Optional. Display name for the instance. "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. + "ipRange": "A String", # Optional. IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation. This optional range, if provided, should be freely available as part of larger named range the customer has allocated to the Service Networking peering. If this is not provided, Apigee will automatically request for any available /22 CIDR block from Service Networking. The customer should use this CIDR block for configuring their firewall needs to allow traffic from Apigee. Input format: "a.b.c.d/22", Output format: a.b.c.d/22, e.f.g.h/28" "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. "location": "A String", # Required. Compute Engine location where the instance resides. "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. @@ -261,6 +263,7 @@Method Details
"diskEncryptionKeyName": "A String", # Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` "displayName": "A String", # Optional. Display name for the instance. "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. + "ipRange": "A String", # Optional. IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation. This optional range, if provided, should be freely available as part of larger named range the customer has allocated to the Service Networking peering. If this is not provided, Apigee will automatically request for any available /22 CIDR block from Service Networking. The customer should use this CIDR block for configuring their firewall needs to allow traffic from Apigee. Input format: "a.b.c.d/22", Output format: a.b.c.d/22, e.f.g.h/28" "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. "location": "A String", # Required. Compute Engine location where the instance resides. "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. @@ -303,6 +306,7 @@Method Details
"diskEncryptionKeyName": "A String", # Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` "displayName": "A String", # Optional. Display name for the instance. "host": "A String", # Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. + "ipRange": "A String", # Optional. IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation. This optional range, if provided, should be freely available as part of larger named range the customer has allocated to the Service Networking peering. If this is not provided, Apigee will automatically request for any available /22 CIDR block from Service Networking. The customer should use this CIDR block for configuring their firewall needs to allow traffic from Apigee. Input format: "a.b.c.d/22", Output format: a.b.c.d/22, e.f.g.h/28" "lastModifiedAt": "A String", # Output only. Time the instance was last modified in milliseconds since epoch. "location": "A String", # Required. Compute Engine location where the instance resides. "name": "A String", # Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. diff --git a/docs/dyn/apigee_v1.organizations.keyvaluemaps.html b/docs/dyn/apigee_v1.organizations.keyvaluemaps.html index 1271a74b5dc..0229ec6fe0e 100644 --- a/docs/dyn/apigee_v1.organizations.keyvaluemaps.html +++ b/docs/dyn/apigee_v1.organizations.keyvaluemaps.html @@ -82,7 +82,7 @@Instance Methods
Creates a key value map in an organization.
-Delete a key value map in an organization.
+Deletes a key value map from an organization.
Method Details
close()@@ -94,13 +94,13 @@Method Details
Creates a key value map in an organization. Args: - parent: string, Required. The name of the organization in which to create the key value map file. Must be of the form `organizations/{organization}`. (required) + parent: string, Required. Name of the organization in which to create the key value map file. Use the following structure in your request: `organizations/{org}` (required) body: object, The request body. The object takes the form of: -{ # A collection of key, value string pairs - "encrypted": True or False, # Optional. If `true` entry values will be encrypted. - "name": "A String", # Required. The id of the key value map. +{ # Collection of key/value string pairs. + "encrypted": True or False, # Optional. Flag that specifies whether entry values will be encrypted. Enable to encrypt entry values. + "name": "A String", # Required. ID of the key value map. } x__xgafv: string, V1 error format. @@ -111,18 +111,18 @@Method Details
Returns: An object of the form: - { # A collection of key, value string pairs - "encrypted": True or False, # Optional. If `true` entry values will be encrypted. - "name": "A String", # Required. The id of the key value map. + { # Collection of key/value string pairs. + "encrypted": True or False, # Optional. Flag that specifies whether entry values will be encrypted. Enable to encrypt entry values. + "name": "A String", # Required. ID of the key value map. }diff --git a/docs/dyn/apikeys_v2.projects.locations.keys.html b/docs/dyn/apikeys_v2.projects.locations.keys.html index a0ebc8dacff..e95e1c85ea9 100644 --- a/docs/dyn/apikeys_v2.projects.locations.keys.html +++ b/docs/dyn/apikeys_v2.projects.locations.keys.html @@ -76,7 +76,7 @@delete(name, x__xgafv=None)-Delete a key value map in an organization. +Deletes a key value map from an organization. Args: - name: string, Required. The name of the key value map. Must be of the form `organizations/{organization}/keyvaluemaps/{keyvaluemap}`. (required) + name: string, Required. Name of the key value map. Use the following structure in your request: `organizations/{org}/keyvaluemaps/{keyvaluemap}` (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -131,9 +131,9 @@Method Details
Returns: An object of the form: - { # A collection of key, value string pairs - "encrypted": True or False, # Optional. If `true` entry values will be encrypted. - "name": "A String", # Required. The id of the key value map. + { # Collection of key/value string pairs. + "encrypted": True or False, # Optional. Flag that specifies whether entry values will be encrypted. Enable to encrypt entry values. + "name": "A String", # Required. ID of the key value map. }API Keys API .
clone(name, body=None, x__xgafv=None)-Clones the existing key's restriction and display name to a new API key. The service account must have the `apikeys.keys.get` and `apikeys.keys.create` permissions in the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+DEPRECATED: API customers can call `GetKey` and then `CreateKey` methods to create a copy of an existing key. Retire `CloneKey` method to eliminate the unnessary method from API Keys API. Clones the existing key's restriction and display name to a new API key. The service account must have the `apikeys.keys.get` and `apikeys.keys.create` permissions in the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.
Close httplib2 connections.
@@ -93,7 +93,7 @@Instance Methods
getKeyString(name, x__xgafv=None)Get the key string for an API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.
-
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.
@@ -107,7 +107,7 @@
list_next(previous_request, previous_response)Instance Methods
Method Details
clone(name, body=None, x__xgafv=None)-Clones the existing key's restriction and display name to a new API key. The service account must have the `apikeys.keys.get` and `apikeys.keys.create` permissions in the project. NOTE: Key is a global resource; hence the only supported value for location is `global`. +DEPRECATED: API customers can call `GetKey` and then `CreateKey` methods to create a copy of an existing key. Retire `CloneKey` method to eliminate the unnessary method from API Keys API. Clones the existing key's restriction and display name to a new API key. The service account must have the `apikeys.keys.get` and `apikeys.keys.create` permissions in the project. NOTE: Key is a global resource; hence the only supported value for location is `global`. Args: name: string, Required. The resource name of the API key to be cloned in the same project. (required) @@ -350,14 +350,15 @@Method Details
-list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)Lists the API keys owned by a project. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`. Args: parent: string, Required. Lists all API keys associated with this project. (required) - filter: string, Optional. Only list keys that conform to the specified filter. The allowed filter strings are `state:ACTIVE` and `state:DELETED`. By default, ListKeys returns only active keys. + filter: string, Optional. Deprecated: Use `show_deleted` instead. Only list keys that conform to the specified filter. The allowed filter strings are `state:ACTIVE` and `state:DELETED`. By default, ListKeys returns only active keys. pageSize: integer, Optional. Specifies the maximum number of results to be returned at a time. pageToken: string, Optional. Requests a specific page of results. + showDeleted: boolean, Optional. Indicate that keys are marked as deleted within 30 days should also be returned. Normally only active keys are returned. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.aptArtifacts.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.aptArtifacts.html index b64b9f32d6d..7a34e83ed47 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.aptArtifacts.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.aptArtifacts.html @@ -80,6 +80,9 @@Instance Methods
import_(parent, body=None, x__xgafv=None)Imports Apt artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.
++
+upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)Directly uploads an Apt artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the imported artifact. Imported artifacts that conflict with existing resources are ignored.
Method Details
+close()@@ -133,4 +136,49 @@Method Details
}++upload(parent, body=None, media_body=None, media_mime_type=None, x__xgafv=None)+Directly uploads an Apt artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the imported artifact. Imported artifacts that conflict with existing resources are ignored. + +Args: + parent: string, The name of the parent resource where the artifacts will be uploaded. (required) + body: object, The request body. + The object takes the form of: + +{ # The request to upload an artifact. +} + + media_body: string, The filename of the media request body, or an instance of a MediaUpload object. + media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response to upload an artifact. + "operation": { # This resource represents a long-running operation that is the result of a network API call. # Operation to be returned to the user. + "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 response of the operation in case of success. 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. + }, + }, +}+