Network Services API . projects . locations . producerExtensions

Instance Methods

close()

Close httplib2 connections.

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

Creates a new `ProducerExtension` resource in a given project and location.

delete(name, etag=None, x__xgafv=None)

Deletes the specified `ProducerExtension` resource.

get(name, x__xgafv=None)

Gets details of the specified `ProducerExtension` resource.

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

Lists `ProducerExtension` resources in a given project and location.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, producerExtensionId=None, x__xgafv=None)
Creates a new `ProducerExtension` resource in a given project and location.

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

{ # `ProducerExtension` is a resource representing producer defined configuration for their service extension.
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "description": "A String", # Optional. A human-readable description of the resource.
  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
  "extensionSettings": { # The configuration for the service that this `ProducerExtension` offers. # Required. The configuration for the service that this `ProducerExtension` offers.
    "authority": "A String", # Optional. The `:authority` header in the request sent to the extension service.
    "observabilityMode": True or False, # Optional. Whether the extension should function in observability mode.
    "service": "A String", # Required. URI of the PSC attachment.
    "supportedEvents": [ # Required. The event types supported by the extension.
      "A String",
    ],
  },
  "labels": { # Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements]((https://cloud.google.com/compute/docs/labeling-resources#requirements).
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Name of the `ProducerExtension` resource in the following format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.
  "phase": "A String", # Required. The phase in which this `ProducerExtension` should execute.
  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
}

  producerExtensionId: string, Required. Short name of the `ProducerExtension` resource to be created.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

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

Args:
  name: string, Required. A name of the `ProducerExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. (required)
  etag: string, Optional. The etag of the ProducerExtension to delete.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

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

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

Returns:
  An object of the form:

    { # `ProducerExtension` is a resource representing producer defined configuration for their service extension.
  "createTime": "A String", # Output only. The timestamp when the resource was created.
  "description": "A String", # Optional. A human-readable description of the resource.
  "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
  "extensionSettings": { # The configuration for the service that this `ProducerExtension` offers. # Required. The configuration for the service that this `ProducerExtension` offers.
    "authority": "A String", # Optional. The `:authority` header in the request sent to the extension service.
    "observabilityMode": True or False, # Optional. Whether the extension should function in observability mode.
    "service": "A String", # Required. URI of the PSC attachment.
    "supportedEvents": [ # Required. The event types supported by the extension.
      "A String",
    ],
  },
  "labels": { # Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements]((https://cloud.google.com/compute/docs/labeling-resources#requirements).
    "a_key": "A String",
  },
  "name": "A String", # Identifier. Name of the `ProducerExtension` resource in the following format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.
  "phase": "A String", # Required. The phase in which this `ProducerExtension` should execute.
  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists `ProducerExtension` resources in a given project and location.

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

Returns:
  An object of the form:

    { # Response returned by the `ListProducerExtensions` method.
  "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.
  "producerExtensions": [ # List of `ProducerExtension` resources.
    { # `ProducerExtension` is a resource representing producer defined configuration for their service extension.
      "createTime": "A String", # Output only. The timestamp when the resource was created.
      "description": "A String", # Optional. A human-readable description of the resource.
      "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.
      "extensionSettings": { # The configuration for the service that this `ProducerExtension` offers. # Required. The configuration for the service that this `ProducerExtension` offers.
        "authority": "A String", # Optional. The `:authority` header in the request sent to the extension service.
        "observabilityMode": True or False, # Optional. Whether the extension should function in observability mode.
        "service": "A String", # Required. URI of the PSC attachment.
        "supportedEvents": [ # Required. The event types supported by the extension.
          "A String",
        ],
      },
      "labels": { # Optional. Set of labels associated with the `ProducerExtension` resource. The format must comply with [the following requirements]((https://cloud.google.com/compute/docs/labeling-resources#requirements).
        "a_key": "A String",
      },
      "name": "A String", # Identifier. Name of the `ProducerExtension` resource in the following format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.
      "phase": "A String", # Required. The phase in which this `ProducerExtension` should execute.
      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
    },
  ],
  "unreachable": [ # Unordered list. Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. The resource names are in the format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.
    "A String",
  ],
}
list_next()
Retrieves the next page of results.

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

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