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

Creates a fleet namespace.

Args:
  parent: string, Required. The parent (project and location) where the Namespace will be created. Specified in the format `projects/*/locations/*/scopes/*`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Namespace represents a namespace across the Fleet
  "createTime": "A String", # Output only. When the namespace was created.
  "deleteTime": "A String", # Output only. When the namespace was deleted.
  "labels": { # Optional. Labels for this Namespace.
    "a_key": "A String",
  },
  "name": "A String", # The resource name for the namespace `projects/{project}/locations/{location}/namespaces/{namespace}`
  "namespaceLabels": { # Optional. Namespace-level cluster namespace labels. These labels are applied to the related namespace of the member clusters bound to the parent Scope. Scope-level labels (`namespace_labels` in the Fleet Scope resource) take precedence over Namespace-level labels if they share a key. Keys and values must be Kubernetes-conformant.
    "a_key": "A String",
  },
  "scope": "A String", # Required. Scope associated with the namespace
  "state": { # NamespaceLifecycleState describes the state of a Namespace resource. # Output only. State of the namespace resource.
    "code": "A String", # Output only. The current state of the Namespace resource.
  },
  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all namespace resources. If a namespace resource is deleted and another resource with the same name is created, it gets a different uid.
  "updateTime": "A String", # Output only. When the namespace was last updated.
}

  scopeNamespaceId: string, Required. Client chosen ID for the Namespace. `namespace_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

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

delete(name, x__xgafv=None)

Deletes a fleet namespace.

Args:
name: string, Required. The Namespace resource name in the format `projects/*/locations/*/scopes/*/namespaces/*`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

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

get(name, x__xgafv=None)

Returns the details of a fleet namespace.

Args:
  name: string, Required. The Namespace resource name in the format `projects/*/locations/*/scopes/*/namespaces/*`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Namespace represents a namespace across the Fleet
  "createTime": "A String", # Output only. When the namespace was created.
  "deleteTime": "A String", # Output only. When the namespace was deleted.
  "labels": { # Optional. Labels for this Namespace.
    "a_key": "A String",
  },
  "name": "A String", # The resource name for the namespace `projects/{project}/locations/{location}/namespaces/{namespace}`
  "namespaceLabels": { # Optional. Namespace-level cluster namespace labels. These labels are applied to the related namespace of the member clusters bound to the parent Scope. Scope-level labels (`namespace_labels` in the Fleet Scope resource) take precedence over Namespace-level labels if they share a key. Keys and values must be Kubernetes-conformant.
    "a_key": "A String",
  },
  "scope": "A String", # Required. Scope associated with the namespace
  "state": { # NamespaceLifecycleState describes the state of a Namespace resource. # Output only. State of the namespace resource.
    "code": "A String", # Output only. The current state of the Namespace resource.
  },
  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all namespace resources. If a namespace resource is deleted and another resource with the same name is created, it gets a different uid.
  "updateTime": "A String", # Output only. When the namespace was last updated.
}

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

Lists fleet namespaces.

Args:
  parent: string, Required. The parent (project and location) where the Features will be listed. Specified in the format `projects/*/locations/*/scopes/*`. (required)
  pageSize: integer, Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.
  pageToken: string, Optional. Token returned by previous call to `ListFeatures` which specifies the position in the list from where to continue listing the resources.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # List of fleet namespaces.
  "nextPageToken": "A String", # A token to request the next page of resources from the `ListNamespaces` method. The value of an empty string means that there are no more resources to return.
  "scopeNamespaces": [ # The list of fleet namespaces
    { # Namespace represents a namespace across the Fleet
      "createTime": "A String", # Output only. When the namespace was created.
      "deleteTime": "A String", # Output only. When the namespace was deleted.
      "labels": { # Optional. Labels for this Namespace.
        "a_key": "A String",
      },
      "name": "A String", # The resource name for the namespace `projects/{project}/locations/{location}/namespaces/{namespace}`
      "namespaceLabels": { # Optional. Namespace-level cluster namespace labels. These labels are applied to the related namespace of the member clusters bound to the parent Scope. Scope-level labels (`namespace_labels` in the Fleet Scope resource) take precedence over Namespace-level labels if they share a key. Keys and values must be Kubernetes-conformant.
        "a_key": "A String",
      },
      "scope": "A String", # Required. Scope associated with the namespace
      "state": { # NamespaceLifecycleState describes the state of a Namespace resource. # Output only. State of the namespace resource.
        "code": "A String", # Output only. The current state of the Namespace resource.
      },
      "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all namespace resources. If a namespace resource is deleted and another resource with the same name is created, it gets a different uid.
      "updateTime": "A String", # Output only. When the namespace was last updated.
    },
  ],
}

list_next()

Retrieves the next page of results.

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

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

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

Updates a fleet namespace.

Args:
  name: string, The resource name for the namespace `projects/{project}/locations/{location}/namespaces/{namespace}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Namespace represents a namespace across the Fleet
  "createTime": "A String", # Output only. When the namespace was created.
  "deleteTime": "A String", # Output only. When the namespace was deleted.
  "labels": { # Optional. Labels for this Namespace.
    "a_key": "A String",
  },
  "name": "A String", # The resource name for the namespace `projects/{project}/locations/{location}/namespaces/{namespace}`
  "namespaceLabels": { # Optional. Namespace-level cluster namespace labels. These labels are applied to the related namespace of the member clusters bound to the parent Scope. Scope-level labels (`namespace_labels` in the Fleet Scope resource) take precedence over Namespace-level labels if they share a key. Keys and values must be Kubernetes-conformant.
    "a_key": "A String",
  },
  "scope": "A String", # Required. Scope associated with the namespace
  "state": { # NamespaceLifecycleState describes the state of a Namespace resource. # Output only. State of the namespace resource.
    "code": "A String", # Output only. The current state of the Namespace resource.
  },
  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all namespace resources. If a namespace resource is deleted and another resource with the same name is created, it gets a different uid.
  "updateTime": "A String", # Output only. When the namespace was last updated.
}

  updateMask: string, Required. The fields to be updated.
  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.
  },
}

GKE Hub API . projects . locations . scopes . namespaces

Instance Methods

Method Details